search

cschlosser / doxdocgen

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

How to use the extension settings? #29

Closed vbotics closed 6 years ago

vbotics commented 6 years ago

Thank you for the great work creating Doxygen Documentation Generator for VS Code. I would like to know how can I access the settings to do the commenting style as shown in the wiki: image

especially using /brief, /param, /author tags etc..

Thanks a lot :+1:

rowanG077 commented 6 years ago

I will write up a short guide tonight.

cschlosser commented 6 years ago

Hey @vbotics just a quick heads-up: Open the settings dialog -> search for "doxygen" -> look for the options starting with doxdocgen.generic. and edit them to your liking in the user settings.

For your case you probably want this in your settings

    "doxdocgen.generic.briefTemplate": "\\brief ",
    "doxdocgen.generic.paramTemplate": "\\param {param} ",
    "doxdocgen.generic.returnTemplate": "\\return {type} "

Please report back if this fixed it for you.

vbotics commented 6 years ago

@christophschlosser Cool that worked like a charm :+1: Thank you :)