Documenting inline functions and pure virtual functions with QDoc
I'm new to QDoc and I'm trying to figure out if I prefer it over Doxygen. There's one thing that annoys be.
QDoc will only look through *.cpp
files for /*!
-style comments, so I can't document inline functi开发者_Python百科ons and pure virtual functions.
Is there a workaround for this?
You can use the \fn
command to refer to a function. For your two cases, put something like this in a .cpp
file:
/*!
* \fn void AbstractClass::pureVirtualMethod()
*
* Some info here...
*/
/*!
* \fn void inlineFunction()
*
* Some info here...
*/
精彩评论