Update API documentation#72
Merged
Merged
Conversation
-Wdocumentation. This adds no new warnings.
derobins
requested review from
gaoikawa,
jordan-turbofish,
kurtmcmillan and
riley-dixon
as code owners
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project's documentation infrastructure by upgrading to Doxygen 1.9.8 and enabling stricter documentation validation. The changes address incorrect parameter documentation in the API headers and enable Clang's -Wdocumentation warning flag to catch documentation issues during compilation.
Key changes:
- Upgraded Doxygen configuration from version 1.8.17 to 1.9.8
- Fixed mismatched parameter names in API documentation (changed
valuetodesc_strand added missinglenparameter) - Enabled
-Wdocumentationcompiler flag for Clang to enforce documentation quality
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/Doxyfile.in | Updated Doxygen configuration file from version 1.8.17 to 1.9.8 with numerous setting updates and new configuration options |
| rocfile/include/rocfile.h | Corrected parameter documentation to match actual function signatures (desc_str and len instead of value) |
| hipfile/include/hipfile.h | Corrected parameter documentation to match actual function signatures (desc_str and len instead of value) |
| cmake/AISClangCompilerOptions.cmake | Enabled -Wdocumentation warning flag for Clang compiler |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kurtmcmillan
approved these changes
Nov 20, 2025
This has flags a lot of missing internal documentation. I'll turn this back on in a future PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.