Doxygen

Описание классов, методов, переменных и т.д.

/// Краткое описание 
/** Подробное описание */ 

///< Краткое описание 
/**< Подробное описание */

\sa Function1(), struct1 и var1

Оформление страниц и разделов

\mainpage Заголовок главной страницы 

Текст главной страницы 

\section sec1 Заголовок секции 1 

Текст секции 1 

\subsection sec1_subsec1 Заголовок подсекции 1 

Текст секции 1 подсекции 1 

\subsection sec1_subsec2 Заголовок подсекции 2 

Текст секции 1 подсекции 2 

\section sec2 Заголовок секции 2 

Текст секции 2 

\subsection sec2_subsec1 Заголовок подсекции 1 
Текст секции 2 подсекции 1 

\page page1 Заголовок страницы 

\ref sec1 
\ref page1 
\ref sec1_subsec1

Вспомогательные элементы оформления

\todo Необходимо сделать 
\bug Ошибка 
\note Текст заметки 

\image html diagrammDataCapture.png 

\li элемент списка 

\code 
Текст кода 
\endcode 

\verbatim 
Текст 
\endverbatim

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *

*