DoxyDoc icon indicating copy to clipboard operation
DoxyDoc copied to clipboard

An option to only include a brief description for functions

Open fgimian opened this issue 8 years ago • 0 comments

Hello there, thanks so so much for producing this extension, it's fantastic!

I was wondering if you would consider an option to have something like this: http://www.edparrish.net/common/cppdoc.html#functioncomment

i.e.

/**
    Encodes a single digit of a POSTNET "A" bar code.

    @param digit the single digit to encode.
    @return a bar code of the digit using "|" as the long
    bar and "," as the half bar.
*/
string encode(int digit);

Personally, I also think it's nice to have a colon after each parameter name similar to Python:

i.e.

/**
    Encodes a single digit of a POSTNET "A" bar code.

    @param digit: the single digit to encode.
    @return: a bar code of the digit using "|" as the long
    bar and "," as the half bar.
*/
string encode(int digit);

Thanks so much! Fotis

fgimian avatar Sep 26 '16 00:09 fgimian