Whole Tomato Software Forums
Whole Tomato Software Forums
Main Site | Profile | Register | Active Topics | Members | Search | FAQ
 All Forums
 Visual Assist
 Feature Requests
 Add template parameters to `Document method`

You must be registered to post a reply.
Click here to register.

Screensize:
UserName:
Password:
Format: BoldItalicizeUnderlineStrikethrough Align leftCenterAlign right Insert horizontal ruleUpload and insert imageInsert hyperlinkInsert email addressInsert codeInsert quoted textInsert listInsert Emoji
   
Message:

Forum code is on.
Html is off.

 
Check to subscribe to this topic.
   

T O P I C    R E V I E W
nholthaus Posted - Feb 09 2016 : 08:22:59 AM
It's current possible to write doxygen documentation snippets for methods like so:

/**
* @brief $end$
* @details
* @param[] $MethodArgName$
* @returns $SymbolType$
*/

It would be nice if vax included a $MethodTemplateName$ (or something) variable which would expand the method's template parameters, so the prior snippet becomes:

/**
* @brief $end$
* @details
* @tparam $MethodTemplateName$
* @param[] $MethodArgName$
* @returns $SymbolType$
*/

Unnamed, default template parameters can be safely ignored for documentation purposes, since they tend to be things like `std::enable_if` or other implementation details you're abstracting from the class user anyway.
1   L A T E S T    R E P L I E S    (Newest First)
accord Posted - Feb 09 2016 : 8:14:00 PM
I have opened a new case for this idea:

case=94953

© 2023 Whole Tomato Software, LLC Go To Top Of Page
Snitz Forums 2000