How do I doxygen-document unnamed parameters of a function?

Question

With doxygen, I'm used to write

/**
 * @brief blah blah
 *
 * @param foo description of foo
 * @param bar description of bar
 * @return description of the return value
 */
int f(int foo, unsigned bar);

But what if I don't name one of the parameter? :

int f(int, unsigned bar);

How can I document this parameter when I can't refer to it by name?

Other than make a textual reference it is, as far as I know, not possible. What is the objection of having a name in the definition / prototype? — albert
– albert, Commented Mar 29, 2019 at 16:56
@albert: When you do not use the parameter, it is (sort of) customary to leave it nameless. — einpoklum
– einpoklum, Commented Mar 29, 2019 at 16:58
Yes I know, but why having the argument in the first place (historical / compatibility is a good reason though). What is the reason for documenting the not used argument? — albert
– albert, Commented Mar 29, 2019 at 17:03
@albert: It might be important to understand why this function is invoked with an extra supposedly-useless parameter, e.g. (in other functions invoked similarly this is used for XYZ, but in this function it isn't because reasons." — einpoklum
– einpoklum, Commented Mar 29, 2019 at 17:17
I think in that case here it should be also 'XYZ' (or 'dummy_xyz') and the description should explain why it is present. — albert
– albert, Commented Mar 29, 2019 at 17:33

einpoklum · Accepted Answer · 2020-07-03 20:54:20Z

3

Doxygen does not currently (July 2020) implement this functionality. However, a feature request has been opened on the Doxygen GitHub issues page for it:

#6926 Feature request: doc for unnamed parameters

answered Jul 3, 2020 at 20:54

einpoklum

137k86 gold badges445 silver badges917 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How do I doxygen-document unnamed parameters of a function?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related