Концептуально в соответствии с restructuredtext , я хочу распределить файлы 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.
HTML_EXTRA_FILES
Если у вас есть простой текстовый файл README, просто добавьте его в каталог программ вручную.
Вы также можете подделать файл .h с тегом \mainpage, чтобы заполнить индексную (главную) страницу вашего вывода кислорода.
.h
\mainpage
В doxygen.config
Добавить FILE_PATTERNS = README
Добавить INPUT = foo_dir
Затем добавить комментарии к foo_dir / README
/ *!
* опус
* @ краткое удивить меня
* @details сделать что-то удивительное
* /
пространство имен README {}