我正在使用 Doxygen 和 Markdown 编写技术手册。Markdown 是为了简化生成 HTML,而 Doxygen 是因为多年来使用它编写代码的经验,并且知道它如何使用该\ingroup
工具生成良好的交叉文档。
我无法让后者在 Doxygen 处理 Markdown 时正常工作。
我想要实现的是编写一个完全描述性的培训文档,但能够标记重要部分并让 Doxygen 将它们拉出到单独的“提示”页面(例如)以供以后快速参考。
这些片段说明了这个问题。所有文件都是.md
,我有一个单独的 mainpage.md,它工作正常。相关的 MARKDOWN 选项在 doxyfile 中设置为 YES。组是使用 /** */ 在文件中定义的,.h
因为那时我无法在 .md 文件中可靠地运行(这可能与此问题有关)。
“第 1 组”文本块
@ingroup group_01
# Group 01 MD heading
Text 1 for Group 1. Mirum est notare quam littera gothica.
一个用于第 2 组文本
@ingroup group_02
# Group 02 MD Heading
Text 1 for group 2. Lorem banana dolor sit amet elit.
以及包含我想要在第 1 组中的信息和第 2 组中的其他部分的文件
@ingroup group_01
@{
# Text 2 group 1
Text 2 for group 1. Duis autem vel eum iriure dolor.
@}
@ingroup group_02
@{
# T2G2 THIS NEVER APPEARS
Text 2 for group 2. Nibble liber tempor cum soluta nobis.
@}
我期望“模块”部分包含两个组的两个条目(确实如此),并且组 1/2 页面包含由@ingroup 标记的文本。
我得到的是第一次看到 @ingroup
的处理完全按照我的预期进行,并且 Doxygen 正确地将各种组条目整理到一个页面上。除此之外的文本根本不会出现在输出中。如果我交换最后一个文件中文本块的顺序,则会出现另一个块,而之前可见的块会消失。
如果我不使用@{ @}
支撑而只使用@ingroup_01
and ,我会得到类似的输出失败@ingroup_02
。FWIW,@ingroup (group_01 group_02)
似乎根本不适用于 Markdown 文件。
我究竟做错了什么?
有没有人有替代建议如何实现我的目标?
我正在使用最新发布的 Doxygen 1.8.5。Doxygen 手册对此没有任何用处。
这个问题与这个问题有一些相似之处,但这是从代码的角度来看问题。