开发者

Documenting inline functions and pure virtual functions with QDoc

开发者 https://www.devze.com 2023-03-14 01:12 出处:网络
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.

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...
 */
0

精彩评论

暂无评论...
验证码 换一张
取 消