Enable -Wdocumentation and fix issues#73
Merged
Conversation
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 enables the -Wdocumentation compiler warning flag for Clang builds and fixes documentation issues that were previously hidden. The changes correct parameter name mismatches between function signatures and their documentation comments, remove incorrect documentation parameters, and add missing return value descriptions.
- Enabled
-Wdocumentationwarning flag in CMake configuration - Fixed parameter name mismatches in documentation comments
- Removed outdated parameter documentation
- Added missing return value description
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| cmake/AISClangCompilerOptions.cmake | Enabled -Wdocumentation warning flag |
| rocfile/src/state.h | Removed outdated @param entries that don't match function signature |
| rocfile/src/context.h | Fixed parameter name from _current to _replacement to match function signature |
| rocfile/src/batch/batch.h | Updated parameter names from ops/num_ops to params/num_params and batch_handle to handle |
| rocfile/src/backend.h | Added missing return value description for score method |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kurtmcmillan
approved these changes
Nov 20, 2025
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.
-Wdocumentation is clang-specific