Repository navigation
Fix two \param names that refer to the member, not the argument - #4594
Merged
Merged
Conversation
Both constructors document the field the argument is stored into rather than the argument itself, so Doxygen renders a parameter that does not exist and leaves the real one undocumented. Comments only.
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
1 task done
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.
Two
\paramtags name the member the argument is assigned to, rather than the argument:In both cases
NumFeaturesandLabelare the struct fields; the constructor arguments arenumFeaturesandlabel. Doxygen matches\paramby name, so it documents a parameter that does not exist and the real one is left undescribed.Changed the two tags to the argument names. Comments only — no signature, initialiser, or behaviour is touched.
Found with a static checker comparing
\paramnames against the declaration below them; both were read by hand against the constructor before changing.