wiki:develop/doxygen

avalon / разработка / документация по исходному коду

Исходный код документируется в формате, воспринимаемом  doxygen. Для построения документации необходимо установить doxygen из репозитория или собрать его из исходных кодов с сайта производителя, после чего запустить скрипт doxygen.sh. По окончании работы скрипта в директории dev/doxygen/html будет содержаться вся необходимая документация, которую можно просмотреть через браузер открыв файл index.html.

Дополнительно к doxygen, для построение графов зависимостей, необходимо установить  graphviz.