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

@brief in first line #325

Open
silverhawk0007 opened this issue Oct 6, 2023 · 1 comment
Open

@brief in first line #325

silverhawk0007 opened this issue Oct 6, 2023 · 1 comment

Comments

@silverhawk0007
Copy link

silverhawk0007 commented Oct 6, 2023

Is it possible to place the generated @brief into the first line?

Actual result:

/**
 * @brief 
 * @param param1 
 * @param param2 
 * @return 
 */
int testFunction(int param1, int param2);

Expected result:

/** @brief 
 * 
 * @param param1 
 * @param param2 
 * @return 
 */
int testFunction(int param1, int param2);

Reason for this feature request: when functions are folded in VS Code, I would like to still see the @brief doxygen comment.

Actual result:

/** ...
int testFunction(int param1, int param2);

Expected result:

/** @brief ...
int testFunction(int param1, int param2);
@Henu-ZhangGao
Copy link

Henu-ZhangGao commented Oct 8, 2023

@silverhawk0007 I suppose it is correspond with you need. In order to implement, what you need to do is modify fileOrder list and firstLine string in json file as following:

"doxdocgen.file.fileOrder": [
        "empty","file","author", "version","date","copyright","custom"
    ],
"doxdocgen.c.firstLine": "/** @brief",
"doxdocgen.generic.order": [
        "empty",
        "tparam",
        "param",
        "return",
        "custom",
        "version",
        "author",
        "date",
        "copyright"
      ],

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants