Fix \param tags in mcr_howard and put_property - #546
Open
karpovantonme wants to merge 1 commit into
Open
Conversation
mcr_howard: three \param tags were written mid-line, so Doxygen read them as prose belonging to the previous parameter rather than as tags. Two more parameters, infty and cmp, are documented but the constructor does not take them: it takes (g, vim, ewm, ew2m) and there is no other overload. put_property: the third argument is an unnamed event filter tag. Doxygen cannot attach a \param to a parameter that has no name, so the tag is now a sentence in 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.
Two Doxygen comments where the tags do not line up with the code. Documentation only, no code touched.
mcr_howard,howard_cycle_ratio.hppTwo separate problems in one comment.
Three
\paramtags are written mid-line, after the text of the previous parameter:Doxygen only recognises a command at the start of a line, so
ewmandew2mare currently read as prose belonging tovim, and the two parameters come out undocumented. Looks like a reflow that ran over the tags at some point.The other half:
inftyandcmpare documented, but the constructor does not take them. It takes(g, vim, ewm, ew2m), andgrepfinds no othermcr_howard(in the file.m_cmpexists as a member and is default-constructed, so the comment may date from a version that took a comparator;inftydoes not appear anywhere in the file outside this comment.I removed those two and put each remaining tag on its own line.
put_property,visitors.hppThe third argument has no name, and Doxygen cannot attach a
@paramto an unnamed parameter. Naming it would document the tag but goes against what the rest of the file does (everyEventTagargument invisitors.hppis unnamed), so I moved the explanation into the description instead and left the signature alone.Both are what
clang -Wdocumentationreports asparameter '...' not found in the function declaration.I can split this into two pull requests if you would rather review them separately.