Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help with config #327

Open
TravisC671 opened this issue Nov 3, 2023 · 0 comments
Open

Help with config #327

TravisC671 opened this issue Nov 3, 2023 · 0 comments

Comments

@TravisC671
Copy link

Description

My college has some pretty strict coding standards and one of them is with documenting with doxygen. I have gotten pretty far with editing the config so that it matches what I'm supposed to write.

Code example

here is what is expected in the coding standard

/** **********************************************************************
 *  @author Travis C.
 *
 *  @par Description
 *  returns the square root of the input
 *
 *  @param[in] input the double to be rooted.
 *
 *  @returns the root of input
 *
 *  @par Example
 *  @verbatim
    double x = 144;
    double result = mySqrt(x); // result would be 12.0

    double x = 4;
    double result = mySqrt(x); // result would be 2.0

    double x = 1010910920190;
    double result = mySqrt(x); // result would be 1005440.65971

    @endverbatim
 ************************************************************************/

What I have

/** **********************************************************************
 * @author Jake T. Calhoun
 * 
 * @par description
 * 
 * @param[in] input
 * 
 * @return double
 * 
 * @par description
************************************************************************/

Here are the settings I have changed

{
  "doxdocgen.c.firstLine": "/** **********************************************************************",
  "doxdocgen.generic.customTags": [
    "@par description"
  ],
  "doxdocgen.generic.order": [
    "author",
    "empty",
    "custom",
    "empty",
    "param",
    "empty",
    "tparam",
    "return",
    "empty",
    "custom",
  ],
  "doxdocgen.c.lastLine": "************************************************************************/",
}

what I'm confused on is how I can add multiple different custom tags. I can add @Par description but it changes it for both custom tags, even what I have is really helpful but this would make it much easier.

@TravisC671 TravisC671 changed the title Help With config Help with config Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant