logo       

A bug (?) dealing with parameters without a name: msg#00074

text.doxygen.general

Subject: A bug (?) dealing with parameters without a name

I am using Doxygen 1.13 RC 3. Generally I am very happy with it.
However, I found some problems with code like the following:

#include <type_traits.h>

/**
* Stores sth for non-POD types.
*
* @param data my data
*/
void store(int data, __false_type)
{
}

/**
* Stores sth for POD types.
*
* @param data my data
*/
void store(int data, __true_type)
{
}

The generated Doxygen documentation for the above code contains
documentation of only "void store (int data, __false_type)". In my real
code (the functions are templated inline class members), the one with
__true_type appears, but with no accompanying documentation and with the
inline attribute lost.

A workaround is to supply an parameter name for __false_type or
__true_type, but that will give rise to other problems (compiler and
doxygen warnings, inconsistencies). I don't think it worth doing.

Is it a known problem? Any solutions?

Best regards,

Wu Yongwei




-------------------------------------------------------
This SF.net email is sponsored by: SlickEdit Inc. Develop an edge.
The most comprehensive and flexible code editor you can use.
Code faster. C/C++, C#, Java, HTML, XML, many more. FREE 30-Day Trial.
www.slickedit.com/sourceforge


<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise