Doxygen：如何包含 Markdown 页面来记录组

Question

我有一个相当复杂的项目，我想使用 doxygen 来记录它。

我在记录代码方面没有任何问题，并且我还设法使用自定义README.md文件加上USE_MDFILE_AS_MAINPAGE = README.mdDoxyfile 中的“”指令来创建一个漂亮的首页。

我定义了几个组 ( @defgroup)，它们在我的文档中显示为“模块”。

我想在每个组中添加一个“主页”，除了惯用的函数/变量/类型文档之外，还提供一般信息。

我尝试添加自定义MODULENAME.md文件以及@includedoc MODULENAME.md组定义中的匹配条目，它似乎有效（我看到几行，例如：“ Generating docs for page md_mcu_noitr_coro_README...”），但我找不到页面是否链接以及在哪里链接（我希望在“详细说明”中看到它） " 对于模块，如果我将一些文档内嵌在我放置 " @includedoc" 指令的位置，就会发生这种情况。

我的一个模块的片段是：

/**
 * @file coro.h
 * @brief definition of coroutine implementing functions.
 *
 * @date: Feb 8, 2018
 * @author: myself
 *
 * @defgroup coro "Coroutine implementation in plain 'C'."
 *
 * @includedoc mcu_noitr/coro/README.md
 * @{
 *
 */

我究竟做错了什么？

注意：还有一点令人惊讶的是，我需要将整个路径放在我所在的位置Doxyfile，否则 doxygen 不会找到它，即使它位于包含@includedoc命令的文件旁边。

Answer 1

目前 doxygen 不考虑这样的命令\includedoc可以包含 markdown 代码。目前唯一的可能性是编写一个过滤器，请参阅INPUT_FILTERdoxygen 配置文件中的配置参数（未经测试！），用该文件的代码替换 \includedoc` 。