5

从概念上讲restructuredtext,我想在我的不同源目录中分发自述文件,然后让Doxygen读取并将这些自述文本文件包含在生成的 Doxygen 输出中。

这是怎么做到的?或者我是否需要通过创建一个伪 C 文件来欺骗 Doxygen,例如:

自述文件.h:

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

3 回答 3

6

如果你只是使用 HTML 输出,你可以只使用HTML_EXTRA_FILESdoxygen 配置文件的字段。

如果您有纯文本 README 文件,只需手动将其添加到您的程序目录中。

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

于 2011-09-14T18:16:40.717 回答
0

在 doxygen.config

添加 FILE_PATTERNS = 自述文件

添加 INPUT = foo_dir

然后在 foo_dir/README 中添加注释

/*!

* 作品

* @brief 让我惊讶

* @details 做了一些了不起的事情

*/

命名空间自述文件 { }

于 2019-01-31T15:58:00.900 回答
0

如果您将自述文件创建为 .md 文件,例如 Bitbucket 自述文件,Doxygen 将自动将其包含在相关页面中。您还可以将 USE_MDFILE_AS_MAINPAGE 设置为首页的 .md 文件。

于 2020-04-16T11:10:56.857 回答