Clear the four -Wdocumentation warnings - #1431
Open
karpovantonme wants to merge 1 commit into
Open
Conversation
lambert_w: \param -term has a hyphen where the parameter is _term, so Doxygen looks for a parameter that does not exist and leaves _term undocumented. find_scale and hyperexponential: three comments start with the character sequence //< or /*<, which the compiler reads as a Doxygen trailing comment marker. Both are accidents, one in commented-out debug output and one in the /*<unnamed>*/ note on a namespace. A space is enough.
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.
Building the two aggregate headers with
-Wdocumentationgives four warnings. This clears them.Two different things behind them.
One real documentation mismatch
lambert_w.hpp:781A hyphen where the other two have an underscore. Doxygen looks for a parameter named
-term, does not find it, and_termends up undocumented.Three accidental Doxygen markers
//<and/*<are how Doxygen marks a trailing comment, and in these three places the sequence turns up by accident.In
find_scale.hppit is inside commented-out debug output, where a line that used to begin with<< quantile(...)became//<< quantile(...):In
hyperexponential.hppit is the note on the unnamed namespace,namespace /*<unnamed>*/ {.Neither is a documentation error, just a character sequence that reads as one. A space fixes both and the comments say the same thing.
I checked through
boost/math/special_functions.hppandboost/math/distributions.hpp, so this covers what those two pull in rather than every header in the library.-fsyntax-onlystays clean after the change.