如何编写自动包含在Doxygen输出中的自述文件？

Question

从概念上讲，沿着restructuredtext，我想在我的不同源目录中分发自述文件，然后让Doxygen读取并包含那些自述文本文件作为生成的Doxygen输出的一部分。

这是怎么做到的？或者我需要通过创建伪C文件欺骗Doxygen，如：

README.h：

/** 
My big long readme file describing how this library 
was created and how it should be used
*/
namespace foo_readme { }

Answer 1

如果您只是使用HTML输出，则可以使用doxygen配置文件的HTML_EXTRA_FILES字段。

如果您有纯文本自述文件，只需手动将其添加到程序目录中。

您还可以使用标签.h欺骗\mainpage文件以填充doxygen输出的索引（主）页面。

Answer 2

在doxygen.config中

添加FILE_PATTERNS =自述文件

添加INPUT = foo_dir

然后在foo_dir / README中添加注释

/*!

* opus

* @brief让我很惊讶

* @details做一些惊人的事情

*/

namespace README {}