doxygen.md

Вступ до документації коду

Загальне завдання

Для лабораторної роботи "Функції" необхідно додати можливість генерації Doxygen документації.

Перелік пакетів/утиліт, що повинні бути встановлено в контексті цієї роботи:

• doxygen;
• mscgen;
• graphviz.

Починаючи з цієї роботи Makefile повинен генерувати Doxygen документацію (наприклад, додав ціль doxygen). У звіті секції опису даних повинні бути скопійовані з результатів Doxygen документації.

У ході виконання роботи, ви повинні отримати наступну структуру.

.
└── lab08
    ├── README.md
    ├── Doxyfile
    ├── Makefile
    ├── src
    │    └── main.c
    └── dist/
         └── html/

Пояснення до структури:

• у ході виконання команди make doxygen, в директорії dist повинна з'явитися директорія html. Зміст цієї директорії не повинен понрапити до системи контроля версіями;
• як і у попередніх роботах, зміст директорії dist не повинен бути зафіксовано у системі контролю версіями;
• файл main.c повинен бути скопійований з лабораторної роботи "Функції". В файл повинно бути додано doxygen документацію.

Зверніть увагу. На головної сторінці doxygen звіту повино бути розташотано контекнт файлу README.md.

Посилання на літературу

• Ефективне документування коду за допомогою Doxygen: https://habr.com/ru/post/252101/

Контрольні питання.

1. Що таке система Doxygen?
2. Які результуючі формати документації підтримує Doxygen?
3. Як у консольному режимі згенерувати документацію до проекту? Що для цього потрібно?
4. Призначення утиліти dot.
5. Призначення пакету mscgen.
6. Як у коді визначити, що поточний коментар потрапить до документації?
7. Які команди необхідні для документування файлу взагалі?
8. Які механізми існують для документування загальної інформації про проект?