Skip to content

An option to only include a brief description for functions #8

Description

@fgimian

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions