doxdocgen icon indicating copy to clipboard operation
doxdocgen copied to clipboard

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

Open ChisholmKyle opened this issue 5 years ago • 4 comments

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); 

ChisholmKyle avatar Jul 28 '19 15:07 ChisholmKyle

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

elupus avatar Jan 27 '20 08:01 elupus

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

bcaddy avatar Nov 10 '20 14:11 bcaddy

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

cschlosser avatar Nov 10 '20 18:11 cschlosser

Thanks for letting me know!

bcaddy avatar Nov 11 '20 13:11 bcaddy