Whole Tomato Software Forums
Whole Tomato Software Forums
Main Site | Profile | Register | Active Topics | Members | Search | FAQ
User name:
Password:
Save Password
Forgot your password?

 All Forums
 Visual Assist
 Feature Requests
 Add template parameters to `Document method`
 New Topic  Reply to Topic
 Printer Friendly
Author Previous Topic Topic Next Topic  

nholthaus
Junior Member

20 Posts

Posted - Feb 09 2016 :  08:22:59 AM  Show Profile  Reply with Quote
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.

Edited by - nholthaus on Feb 09 2016 10:58:04 AM

accord
Whole Tomato Software

United Kingdom
3287 Posts

Posted - Feb 09 2016 :  8:14:00 PM  Show Profile  Reply with Quote
I have opened a new case for this idea:

case=94953
Go to Top of Page
  Previous Topic Topic Next Topic  
 New Topic  Reply to Topic
 Printer Friendly
Jump To:
© 2023 Whole Tomato Software, LLC Go To Top Of Page
Snitz Forums 2000