cschlosser / doxdocgen

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

Option to append [in] to param when function parameter is `const` #122

Open ChisholmKyle opened 5 years ago

ChisholmKyle commented 5 years ago

Description

If a function parameter has the keyword const, the generated documentation could have [in] appended to param to denote it as an input. This can be toggled as an optional feature.

Code example

size_t some_function(const char * buf, const size_t buflen, char *bufout); 

Expected result

/**
 * @brief 
 * 
 * @param[in] buf 
 * @param[in] buflen
 * @param bufout 
 * @return size_t 
 */
size_t some_function(const char * buf, const size_t buflen, char *bufout); 

Actual result

/**
 * @brief 
 * 
 * @param buf 
 * @param buflen 
 * @param bufout 
 * @return size_t 
 */
size_t some_function(const char * buf, const size_t buflen, char *bufout); 
elupus commented 4 years ago

Syntax highlighting seem to break down when [in] [out] tags are used for @param section. Probably separate issue i just realized.

bcaddy commented 3 years ago

I'm also having this issue with syntax highlighting. As soon as I add [in], [out], or [in,out] all the syntax highlighting vanishes

cschlosser commented 3 years ago

@bcaddy that is not an issue of this addon. This is a problem with https://github.com/microsoft/vscode-cpptools syntax highlighting for Doxygen.

bcaddy commented 3 years ago

Thanks for letting me know!