Чтобы создать документацию в формате Doxygen, необходимо выполнить следующие шаги:

1. Установить Doxygen. 3 Для разных операционных систем есть свои команды установки: 3

• для Ubuntu: sudo apt-get install doxygen; 3
• для Arch Linux: sudo pacman -S doxygen. 3

1. Создать файл с настройками. 1 Каждому проекту соответствует свой файл настроек. 1 В нём можно прописать путь до исходников проекта, путь, по которому должна быть создана документация, а также другие опции. 1

2. Добавить в проект комментарии специального формата. 2 Они могут быть для файлов (.h, .cpp), для класса, для переменных класса, для функций (с указанием параметров и возвращаемого значения). 2

3. Запустить программу Doxygen. 2 Указать ей путь к файлу с настройками. 2

4. Настроить генерацию справки. 2 В первом окне настроек (вкладка Project) указать: 2

• путь к рабочему каталогу (например, каталог пользователя); 2
• название проекта; 2
• путь к исходному коду (папка с исходниками проекта); 2
• флаг рекурсивного сканирования; 2
• путь к создаваемой документации. 2

1. Сгенерировать документацию. 2 Если генерация прошла успешно, то откроется кнопка Show HTML Output. 2 При нажатии на неё в окне браузера откроется главная страница созданной документации. 2

2. Изменить документацию. 2 Если необходимо изменить документацию, то следует: 2

• открыть файлы с исходным кодом проекта; 2
• изменить в них комментарии; 2
• сохранить файлы проекта; 2
• заново запустить программу генерации документации; 2
• просмотреть полученный результат (обновить окно браузера). 2