cschlosser / doxdocgen

Generate doxygen documentation from source code in VS Code
https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen
MIT License
258 stars 54 forks source link

Generating redundant asterix #321

Open lgacnik opened 11 months ago

lgacnik commented 11 months ago

Description

After typing in /** above methods in class and pressing Enter, one extra blank line with no Doxygen command is generated (in the last line before end of comment line) but it feels rather redundant.

Expected result

2023-07-19 19_11_14-● foo cpp - CppCourseUdemy - Visual Studio Code

Actual result

2023-07-19 19_11_06-● foo cpp - CppCourseUdemy - Visual Studio Code

Can I edit in settings that last asterix before */ end-of-comment terminator is not generated?

Henu-ZhangGao commented 10 months ago

@MucaGinger According to what you asked and posted, i can suppose you have never modified setting.json. So if you wanna omit the redundant asterix, you just need to reconfigure doxdocgen.file.fileOrder from setting.json that you can finds out by searching "Open Settings". More detail, you can press ctrl+shift+p to open search box and type Open Setting and following example that i give at below.

For example, you can set it in setting.json as following:

{
    "doxdocgen.generic.useGitUserEmail": true,
    "doxdocgen.generic.useGitUserName": true,
    "doxdocgen.generic.commandSuggestionAddPrefix": true,
    "doxdocgen.file.fileOrder": [
       "file","author","brief", "version","date","copyright"
       //default setting: "file","author","brief", "version","date","empty","copyright","empty"
    ],
}

and it appears as

/**
 * @file test.c
 * @author myName (myName@domain.com)
 * @brief 
 * @version 0.1
 * @date 2023-08-11
 * @copyright Copyright (c) 2023
 */
#include <stdio.h>
int main(){
    return 0;
}

If you can't understand it, you can DM me.