Загальні положення 4 Частина Основи мови С++ 9

Спеціальні команди системи Doxygen
Команди починаються із символу @ (at-sign) або \ (backslash) і розташовуються в тілі коментарів, оформлених зазначеним вище способом.
Нижче (табл. 11.1) приводиться короткий опис деяких команд.
Таблиця 11.1 – Скорочений список команд системи Doxygen

Команда	Призначення
@author author_name	Вказується ім’я автора
@authors	Те ж, що й @author
@code ... @endcode	Операторні дужки визначають блок тексту, який повністю включається в документ. Стиль тексту буде відрізнятися від звичайного.
@date xx.xx.xx	Вказується дата
@exception	Те ж, що й @throws
@file file_name.ext Опис	Вказує на те, що документується файл із вихідним кодом по імені «file_name.ext»
@param param_name Опис	Опис параметра функції або методу. Ім’я параметра – «param_name». Можна вказати напрямок параметра атрибутами [in], [in,out] або [out], наприклад, @param[out] ...
@remark	Те ж, що й @remarks
@remarks Текст примітки	Містить текст примітки
@return	Те ж, що й @returns
@returns Опис	Опис результату, що повертається
@sa	Те ж, що й @see
@see references	Перехресне посилання. Кілька посилань можна розділяти символом |
@throw	Те ж, що й @throws
@throws Опис	Опис виключення, що викидається
@version version_info	Інформація про версію

Повна довідка по командах системи Doxygen знаходиться в прикладеній до пакета документації (див. файл: «C:\Program Files\doxygen\html\ commands.html»)

Приклад використання Doxygen для створення діаграм
На рис.11.7 наведений приклад діаграми зв’язків, отриманої в результаті обробки системою Doxygen наступного тексту:

class Invisible { };

class Truncated : public Invisible { };
class Undocumented { };
class PublicBase : public Truncated { };
template class Templ {};
class ProtectedBase { };
class PrivateBase { };
class Used { };
class Inherited : public PublicBase, protected ProtectedBase,
private PrivateBase, public Undocumented, public Templ {
private:
Used *m_usedClass;
};



Рисунок 11.7 – Діаграма зв’язків, що згенерована системою Doxygen