[doc] Drop the dangling \param from empty_formatter - #133
Open
karpovantonme wants to merge 1 commit into
Open
Conversation
The argument of empty_formatter has no name, so \param has nothing to bind to and Doxygen drops the description. The dash currently standing in for the name is not a name either, and it is the only one in the library: 1 of 725 \param tags here, and none in the other Boost libraries. The explanation moves into the description, and the argument gets a commented name the way replace_storage.hpp already writes it.
Contributor
|
Looks good. |
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.
empty_formattertakes its argument only to deduce a type, so the argument has no name:Doxygen has nothing to bind that
\paramto, so the description does not reach the generated page. The dash standing in for the name is not a name either. It is also the only one of its kind: 1 of 725\paramtags in this library, and I did not find another in the 44 other Boost libraries I have checked outSo the explanation moves into the description text, where it is not tied to a name, and the argument gets a commented name the way
string/detail/replace_storage.hpp:65already writes it:And no behaviour change, and no unused-parameter warning added for anyone building with
-WextraSo two siblings in the same header,
const_formatter(const RangeT& Format)anddissect_formatter(const FinderT& Finder), both name their argument and both document it correctly, so this was the odd one outFound with a checker I wrote with help from Claude Opus 5, and read by hand before proposing