Fix three parameter tags - #252
Open
karpovantonme wants to merge 1 commit into
Open
Conversation
local_is_dst documents dst_length_minutes; the parameter is dst_length, and it is a time_duration_type rather than a count of minutes. gather_month_strings and gather_weekday_strings tag charT with @param while it is the template parameter, so Doxygen looks for an argument by that name and finds none.
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.
Three Doxygen tags that do not match the declaration below them. Documentation only.
local_is_dst,dst_rules.hppThe parameter is
dst_length. The_minutessuffix looks like a leftover from when it was a count rather than atime_duration_type; the six tags above it all match.gather_month_stringsandgather_weekday_strings,strings_from_facet.hppcharTis the template parameter, so it wants@tparam. As written, Doxygen looks for a function argument calledcharT, does not find one, and the template parameter ends up undocumented.Both are what
clang -Wdocumentationreports asparameter '...' not found in the function declaration.