Skip to content

[SYCL] Fix some Doxygen build warnings #4170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 28, 2021
Merged

Conversation

vmaksimo
Copy link
Contributor

@vmaksimo vmaksimo commented Jul 23, 2021

This is done as a part of #4140

  • Changed several parameter types to parameter argument names (under \param tag)
  • Renamed parameter names as they were changes in code, but not in documentation comment

@vmaksimo vmaksimo requested review from smaslov-intel and a team as code owners July 23, 2021 14:12
@bader
Copy link
Contributor

bader commented Jul 23, 2021

@vmaksimo, thank you for fixing this!

@vmaksimo
Copy link
Contributor Author

@vmaksimo, thank you for fixing this!

This is only the first step, but it should be a good start to fix the rest warnings :)

Comment on lines -435 to -437
/// \param Pointer to the stream object
/// \param Size of the stream buffer
/// \param Size of the flush buffer for a single work item
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will it really help without naming of arguments?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it's better to leave the documentation with named arguments as it was planned by the author

@bader bader merged commit 0e22fdd into intel:sycl Jul 28, 2021
zahiraam pushed a commit to zahiraam/llvm-1 that referenced this pull request Aug 2, 2021
This is done as a part of intel#4140

* Changed several parameter types to parameter argument names (under \param tag)
* Renamed parameter names as they were changes in code, but not in documentation comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants