Name the parameters isInList actually takes - #58
Open
karpovantonme wants to merge 1 commit into
Open
Conversation
The block documents tag and tags, which belong to isTagInList just below it. isInList takes i and list, so Doxygen drops both entries and the function renders with no parameters at all. clang -Wdocumentation on util/methods.h: two warnings before, none after.
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.
Fixes #
Proposed Changes
isInListdocumentstagandtags, but those are the parameters ofisTagInListright below it -- the block looks copied from there. The function itself takesiandlist, so Doxygen drops both entries and it renders with no parameters at allTwo warnings before, none after.
Any background context you want to provide?
The wording is not invented,
addToListtwo functions further down already documents the same pair:Found while running
-Wdocumentationacross a set of C++ projects. It was the only hit in PeriDEM that is a real mismatch -- the rest of the header uses@return name description, which Doxygen handles fine and I left alone