Doxygen позволяет, помимо документации на классы и пространства имен, включать в документацию код примеров использования библиотеки С++. В прошлой статье мы создали примеры использования кода для нашей библиотеки С++ и настроили их сборку с помощью CMake. Сегодня мы добавим к документации библиотеки С++ код примеров и задокументируем сами примеры.

Doxygen облегчает создание документации для вашего проекта, но вместе с тем, требует запуска отдельной программы для сборки документации. В прошлой статье мы рассмотрели создание документации для библиотеки C++ с помощью Doxygen. Сегодня мы добавим настройки для CMake, чтобы облегчить настройку и автоматизировать сборку документации.

Одним из этапов разработки любой программы или библиотеки на C++ является создание документации. В зависимости от проекта этот процесс может отнимать большое количество сил и времени. Чтобы облегчить создание документации был создан Doxygen. Добавляя в код своего проекта комментарии, использующие особую нотацию в формате Doxygen, вы не только делаете код понятнее, но и после сборки, получаете документацию в формате html, а при желании и в PDF. Сегодня мы рассмотрим создание документации для библиотеки C++ с помощью Doxygen.