[doc] Document the format tag without a \param - #794
Merged
Conversation
Both read_image_info overloads carry \param tag, but the FormatTag argument has no name in the declaration and Doxygen cannot attach a \param to one. Naming it would produce an unused parameter, and every other FormatTag argument across io/ is unnamed too, so the explanation moves into the description instead.
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.
Both
read_image_infooverloads document atagparameter, and the argument it refers to has no name:Doxygen cannot attach a
\paramto an unnamed argument, so it reportstagas a parameter that does not exist and the format tag ends up undocumented either way.Two ways to fix it, and I picked the second:
tag. It is never used in the body, so this would produce an unused-parameter warning, and every otherFormatTagargument acrossio/is unnamed as well, so it would also break with the surrounding style;The wording is the same as before, only the position changed.