c++ - How do I find correct doxygen reference to things with complicated signatures? -
i documenting functions template overloads , want reference specific overloads. don't know how type signature \ref command understand; unfortunately requires canonical version , don't know it. there way get list of canonical signatures doxygen generated?
my specific case function declared this:
template <typename t, size_t s> int function(t value, table const (&descriptors)[s]); i've tried
\ref function(t,table(&)[]) \ref function<>(t,table(&)[]) \ref function(t,const table(&)[]) \ref function<>(t,const table(&)[]) \ref function(t,table const(&)[]) \ref function<>(t,table const(&)[]) and i've tried without \ref (it's supposed notice symbols automatically), no better.
or there way define reference myself?
i've tried defining anchor in target function documentation, points description body , not header reference function should.
a bug in doxygen prevented @ref'ing parameters type included braces. i've committed possible solution github. let me know if works you.
i used following example test myself:
/** @file */ /** complex function */ template <typename t, size_t s> int function(t value, table const (&descriptors)[s]); /** @mainpage * see @ref function(t,table const (&)[s]) "complex function" details. */
Comments
Post a Comment