Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Doxygen: Documenting overloaded functions

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.
  */
like image 316
Paul Manta Avatar asked Apr 12 '11 14:04

Paul Manta


1 Answers

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. :)

like image 190
SolarBear Avatar answered Sep 19 '22 11:09

SolarBear