Концептуально в духе реструктурированного текста я хочу распределить файлы readme по разным исходным каталогам, а затем попросите Doxygen прочитать и включить эти текстовые файлы readme как часть сгенерированного вывода Doxygen.
Как это делается? Или мне нужно подделать Doxygen, создав псевдо-файл C, например:
README.h:
/**
My big long readme file describing how this library
was created and how it should be used
*/
namespace foo_readme { }
Если вы просто используете вывод HTML, вы можете просто использовать поле HTML_EXTRA_FILES конфигурационный файл doxygen.
Если у вас есть обычный текстовый файл README, просто добавьте его в каталог программы вручную.
Вы также можете подделать файл .h тегом \mainpage для заполнения индекса ( main) страница вашего вывода doxygen.
В doxygen.config
Добавьте FILE_PATTERNS = README
Добавить INPUT = foo_dir
Затем добавьте комментарии в файл foo_dir/README.
/*!
* опус
* @краткий порази меня
* @details делают что-то потрясающее
*/
пространство имен README { }
Если вы создадите свой файл README в виде файла .md, например, файл Readme Bitbucket, он будет автоматически включен Doxygen на связанные страницы. Вы также можете установить USE_MDFILE_AS_MAINPAGE в файл .md для своей главной страницы.
