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

Add ability to pick what custom tag to use #316

Open NickBishop97 opened 1 year ago

NickBishop97 commented 1 year ago

Is your feature request related to a problem? Please describe. I'm trying to create a custom generated doxygen comment for functions, but I need to include things that require the custom field and normal features(brief, return, param, tparam). However, I need these custom fields to be included in certain positions and not print the whole field each time a custom tag is seen by the parser.

Describe the solution you'd like I would want the custom Tags to be the same but the order be along the lines of picking which item from the custom tag to print. This new syntax would also apply to the file custom tag also. However you could still use the old method to print the whole custom tag list.

  "doxdocgen.generic.customTags": [
   "details",
   "pre",
   "post"
],

  "doxdocgen.generic.order": [
    "brief",
    "custom{0}",   // Print out details only
    "param [in]",
    "param [out]",
    "custom{1}",    // Print out pre only
    "custom{2}",   // Print out post only
],

Additional context Picture of what it would look like when generated

Code_rxCRUq7bTR