从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 { }
答案 0 :(得分：6)
如果您只是使用HTML输出，则可以使用doxygen配置文件的HTML_EXTRA_FILES字段。
如果您有纯文本自述文件，只需手动将其添加到程序目录中。
您还可以使用标记\mainpage欺骗.h文件，以填充doxygen输出的索引（主）页面。
答案 1 :(得分：0)
在doxygen.config中
...添加FILE_PATTERNS =自述
添加INPUT = foo_dir
然后将注释添加到foo_dir / README
/ *！
*作品
* @brief使我惊奇
* @details做一些惊人的
* /
命名空间自述文件{}
答案 2 :(得分：0)
如果您将自述文件创建为.md文件（例如Bitbucket自述文件），则Doxygen将自动将其包含在“相关页面”中。您还可以将USE_MDFILE_AS_MAINPAGE设置为首页的.md文件。