In case I have my documentation separate from my code, how do I help Doxygen distinguish between overloaded functions (what to use in the \fn
field)? A single function would be documented like this:
void func() {
}
/**
\fn func
\details Description here.
*/
What if I have two functions called func
?
void func() {
}
void func(int i) {
}
/**
\fn [What goes here?]
\details Description here.
*/
There is an \overload doxygen command for such cases. See the doxygen command reference. Use your regular \fn command for the base case and use \overload for any, well, overload. :)
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With