如何编写自动包含在 Doxygen 输出中的自述文件？
从概念上讲，沿着 restructedtext 的思路，我想在不同的源目录中分发自述文件，然后让 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 { }
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（3）
如果您仅使用 HTML 输出，则只需使用
HTML_EXTRA_FILESdoxygen 配置文件的字段。如果您有纯文本自述文件，只需手动将其添加到您的程序目录中。
您还可以使用标签
.h文件>\mainpage 填充 doxygen 输出的索引（主）页面。If you're just using HTML output you can just use the
HTML_EXTRA_FILESfield of the doxygen configuration file.If you have a plain text README file just add it to your program directory manually.
You can also spoof a
.hfile with the tag\mainpageto populate the index (main) page of your doxygen output.在 doxygen.config 中
添加 FILE_PATTERNS = README
添加 INPUT = foo_dir
然后将注释添加到 foo_dir/README
/*!
*作品
*@brief令我惊讶
*@details做了一些令人惊奇的事情
*/
命名空间自述文件{}
In doxygen.config
Add FILE_PATTERNS = README
Add INPUT = foo_dir
Then add comments to the foo_dir/README
/*!
* opus
* @brief amaze me
* @details do something amazing
*/
namespace README { }
如果您将自述文件创建为 .md 文件（例如 Bitbucket 自述文件），Doxygen 将自动将其包含在相关页面中。您还可以将 USE_MDFILE_AS_MAINPAGE 设置为首页的 .md 文件。
If you create your README as a .md file, like a Bitbucket Readme, it will be included automatically by Doxygen in the Related Pages. You can also set USE_MDFILE_AS_MAINPAGE to a .md file for your front page.