[doc] Fix the template parameter names in three Doxygen blocks - #443
Open
karpovantonme wants to merge 1 commit into
Open
[doc] Fix the template parameter names in three Doxygen blocks#443karpovantonme wants to merge 1 commit into
karpovantonme wants to merge 1 commit into
Conversation
- accumulators::count documents @tparam T, the parameter is ValueType. ThreadSafe next to it is right. - weight_type and sample_type document @tparam Underlying, which reads as an adjective but Doxygen takes as the parameter name, so it documents a parameter called "Underlying" and reports T as undocumented. Adding the name keeps the wording intact.
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 blocks name a template parameter the declaration does not have. Comments only.
accumulators/count.hppThreadSafeis right,Tshould beValueType.weight.hppandsample.hpp"Underlying" reads as an adjective here, but Doxygen takes the first word after
@tparamas the name, so it documents a parameter calledUnderlyingand reportsTas undocumented. Inserting the name leaves the sentence as it was:@tparam T Underlying arithmetic type.Same insample.hpp.I checked the rest of
accumulators/andaxis/for the same thing;count.hppis the only one there, the axis blocks all match their declarations.Not included
A sweep of the whole library also flags
axis/traits.hpp,histogram.hpp,indexed.hpp,unsafe_access.hppand the fiveutility/*_interval.hppheaders, but every one of those is my parser failing onauto&¶meters and onoperator(), not a real mismatch — I read them and the docs are correct. Mentioning it so nobody repeats the check and thinks there is more here.