При написании любой библиотеки очень важно предоставить пользователям рабочие примеры использования вашей библиотеки. Это позволит избежать лишних вопросов и сделает библиотеку удобнее для программистов. В прошлой статье мы написали документацию для библиотеку C++ ColorConsole с использованием Doxygen. Сегодня мы добавим для неё примеры использования.

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

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

CMake предоставляет программисту богатый инструментарии для сборки и установки библиотек и программ, в том числе и возможность установить статическую и разделяемую (shared) версии библиотек. Сегодня мы модернизируем скрипты CMake, чтобы упростить настройку и внесение изменений в проект, а также рассмотрим одновременную установку статической и разделяемой версий нашей библиотеки.

Разделяемые (shared) библиотеки широко применяются в рамках любой операционной системы будь то Linux или Windows. Их широкое использование позволяет серьезно экономить дисковое пространство и оперативную память, позволяя загружать только востребованный код и использовать одни и те же библиотеки во многих приложениях. Некоторые такие библиотеки и вовсе обязательно используются всеми приложениями, запускаемыми операционной системой. Сегодня мы пойдем дальше и рассмотрим сборку и установку разделяемой (shared) библиотеки C++ с помощью CMake как в отдельную папку, так и в системные папки Msys2.