nholthaus
Junior Member
20 Posts |
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. |
Edited by - nholthaus on Feb 09 2016 10:58:04 AM |
|