Документирование встроенных функций и чисто виртуальных функций с помощью QDoc - PullRequest
2 голосов
/ 18 июня 2011

Я новичок в QDoc , и я пытаюсь выяснить, предпочитаю ли я его по сравнению с Doxygen.Есть одна вещь, которая раздражает:

QDoc просматривает только *.cpp файлы для комментариев /*!, поэтому я не могу документировать встроенные функции и чисто виртуальные функции.

ЕстьЕсть ли обходной путь для этого?

1 Ответ

3 голосов
/ 18 июня 2011

Вы можете использовать команду \fn для ссылки на функцию. Для ваших двух случаев поместите что-то вроде этого в файл .cpp:

/*!
 * \fn void AbstractClass::pureVirtualMethod()
 *
 * Some info here...
 */

/*!
 * \fn void inlineFunction()
 *
 * Some info here...
 */
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...