Doxygen auto param generate

Question

Is there any tool or plugin for visual studio c++ to generate an auto pre-structure of doxygen comments, based on the definition of function?

Thank you.

something like this example:

/**
 *****************************************************************************************
 *  @brief      
 *
 *  @usage      
 * 
 *  @param      
 *  @param      
 *
 *  @return     
 ****************************************************************************************/

int TestAPI2(
    int argument1,
    int argument2
    );

You can use [Visual Assist X](http://www.wholetomato.com/) for this (note that it's not free). — Angew is no longer proud of SO, Jan 28 '14 at 10:37

score 0 · Accepted Answer · answered Jan 28 '14 at 18:50

I'd suggest instead you document inline with the parameters

int TestAPI2(
    int argument1, /**< does this **/
    int argument2 /**< does that, should never be a prime number, 
                       and I keep wanting to go on and on about it. **/
    );

Any tool that automatically documents the parameters will produce useless documentation someone else has to fill in anyway.

You can set WARN_NO_PARAMDOC = YES in your doxygen file if you want a list of parameters that have not been documented.

That said, you could try Gostdoc if you have some process constraint where meaningless comments are "better" than no comments.

Of note, inline documentation makes it easier to keep stuff orderly when parameters change than documenting in the method header. — Denise Skidmore, Jan 28 '14 at 18:54

Doxygen auto param generate

1 Answers1