Версия для печати темы

Нажмите сюда для просмотра этой темы в обычном формате

Форум на CrossPlatform.RU _ Qt Общие вопросы _ Теги комментирования в Qt

Автор: legat 8.8.2010, 16:22

Простите если данная тема уже поднималась, просто никак не найду ответа.
Просматривал исходники Qt и обнаружил следующую систему комментирования, например:

/** \class VolumeSlider volumeslider.h Phonon/VolumeSlider
* \short Widget providing a slider to control the volume of an AudioOutput.
*
* \ingroup PhononWidgets
* \author Matthias Kretz <kretz@kde.org>
*/
class PHONON_EXPORT VolumeSlider...
Следовательно имеется чёткий набор тегов для комментирования, таких как \class, \brief и т.п.
1) Подскажите, где можно найти исчерпывающую документацию по данным тегам (записывающихся через обратный слэш)?
2) Как будто с помощь этих тегов и Assistant-а можно сделать документацию к своему коду. Как это сделать?

Заранее спасибо.

Автор: Litkevich Yuriy 8.8.2010, 17:56

legat, троли не рекомендуют использовать их qdoc3, т.к. он может изменятся от выпуска к выпуску и он не имеет официальной документации.

Наиболее распространённая система документирования для Си++ - http://www.doxygen.org/. (его, к стати, разработал автор qdoc после его ухода из Trolltech.

тут вот что-то на русском: http://www.doxygenorg.ru/

Форум Invision Power Board (http://www.invisionboard.com)
© Invision Power Services (http://www.invisionpower.com)