27 ноября состоялся выпуск 0.8.0 консольного генератора документации из исходного кода C++ doxide, написанного на языках C и C++, и распространяемого по лицензии Apache 2.0.
Исходный код C++ документируется с помощью /** комментариев */
, содержащих @-команды
, как в классическом инструменте Doxygen. Многие команды Doxygen уже поддерживаются. Для конфигурации используется формат YAML.
Doxide генерирует документацию в формате Markdown, и для парсинга исходного кода использует инкрементальные парсеры проекта tree-sitter.
Из других зависимостей – CMake, компилятор C++20 и git-субмодули CLI11, glob и libyaml. В зависимости от используемого дистрибутива ОС может потребоваться наличие библиотеки ICU.
Список изменений:
- важнейшая новая функция – отчёты о покрытии кода, объединяющие данные из скомпилированных двоичных файлов, предоставляемых gcov, с анализом исходного кода с помощью tree-sitter для более точных отчётов о покрытии кода C++;
- исправлена генерация файла
mathjax.js
. Для исправления нужно снова выполнить$ doxide init
, отвечая «N» (по умолчанию) на запрос о перезаписи файлов, и «y» для этого конкретного файла.
>>> Подробности