Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Doxygen for documenting overloaded functions with variable parameters

Is it possible to make doxygen to create proper documentation for code like this:

void Print(const char* pszFormat, ...);
void Print(const wchar_t* pszFormat, ...);

I have two problems with this code. First I can't refer to both of these functions from other parts of my code. For \ref Print(const char*, ...); and \ref Print(const wchar_t*, ...); links to only one of the above declarations are generated.

Also the variable arguments are placed in a predefined format which has to be described. Trying to use the '\param' tag for it leads to warnings about the parameters are not found in the function declaration. Since I have multiple of such functions I would like to get rid of the warnings specifically for this case if it is possible.

Thanks in advance.

like image 471
lpszTemp Avatar asked May 26 '14 10:05

lpszTemp


1 Answers

If you specify the parameter literally as ..., it will be picked up by Doxygen. E.g. as follows:\param[in] ... Arguments for format specification. This will appear properly in your generated documentation.

No clue about the disambiguation of the const char* and const wchar_t* though.

like image 151
stamppot Avatar answered Oct 08 '22 12:10

stamppot