Doxygen 1.8.7
In a class, I have a function within which an inner class is declared.
//*! This is a test class
*/
class TestClass {
/*! \brief A function which does something
/* \param param_A this is the first parameter of doSomething function
/* \param param_B this is the second parameter of doSomething function
*/
void doSomething(int param_A, int param_B) {
/*! This is an inner Test Class
*/
class InnerTestClass {
/*! \brief A constructor for InnerTestClass
* \param param_C this is the parameter for the InnerTestClass inner class
constructor
*/
InnerTestClass (int param_C) {
}
}
/
When I generate the doxygen documentation for the above class, a confusion
occurs between the documentation for the function doSomething and the inner
class InnerTestClass.
1. No inner class documentation file called classInnerTestClass.html is
created.
2. In the documentation for classTestClass.html, the documentation for the
InnerTestClass is included with the documentation for the function, as
follows:
/doSomething(int param_A
int param_B
)
A function which does something
Parameters
param_A this is the first parameter of doSomething function
param_B this is the second parameter of doSomething function
This is an inner Test Class
Parameters
param_C this is the parameter for the InnerTestClass inner class
constructor/
3. Warning messages are shown indicating that param_A and param_B are not
documented and that param_C is not found in the argument list of
doSomething.
--
View this message in context: http://doxygen.10944.n7.nabble.com/Confusion-between-documentation-of-function-and-inner-class-tp7208.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.
|
