Support in/out parameter tags

[PlasmaHH]

Doxygen supports in/out tags for parameters like

/**
 * \brief some function
 * \param[in] p1 first param
 * \param[out] p2 second param
 */
void some_function( int p1, int& p2 );

This could be activated with an option and each in/out could be a point to be cycled through with tabs. The defaults at least for C++ could depend on whether the parameter is a non-const ref or pointer.

[kkoomen]

Hi!

This is something I haven't noticed myself, but this is a good suggestion to improve overall documentation. I've implemented this for C and C++ when using doxygen. I've made it into a jumpable TODO like so:

/**
 * @brief [TODO:summary]
 *
 * @param[[TODO:direction]] p1 [TODO:description]
 * @param[[TODO:direction]] p2 [TODO:description]
 */
void some_function( int p1, int& p2 );

This way, developers can always add it or remove it. In the end, it would be better to specify it as much as possible, hence I've made included it in the default docblock being generated.

Side note: I see that you do use \param. I just resolved #534 for you as well. Thank you for making these two issues as separate issues, I appreciate it.

[kkoomen]

This feature has been merged and released in v3.20.0.

Feel free to submit any new issues if you experience any unwanted behaviour in the future. Thanks for your contribution.

[PlasmaHH]

Very nice, since I always use them this works just fine for me.

I was wondering though if some people might not like it and then hit del to remove the TODO:direction part but then are left with empty [] ... They might want those to vanish then too... Not sure if its possible to implement there... ( I know ultisnips supports something similar, which is why I had the idea that someone in the future might want it easier to remove the empty [] )