如何使用Markdown页面和Doxygen组?

时间:2013-10-31 11:07:01

标签: markdown doxygen

我正在使用Doxygen和Markdown编写技术手册。降低生成HTML的简单性和Doxygen,因为多年来使用它代码并知道如何使用\ingroup工具生成良好的交叉文档。

我没有让后者在Doxygen处理Markdown时正常工作。

我想要实现的是编写完整描述性的培训文档,但是能够标记重要部分并让Doxygen将这些部分拉出到单独的“提示”页面(例如)以便稍后快速参考。

这些片段说明了这个问题。所有文件都是.md,我有一个单独的mainpage.md工作正常。 doxyfile中的相关MARKDOWN选项设置为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@ingroup_02,我会收到类似的输出失败。 FWIW,@ingroup (group_01 group_02)似乎根本无法在Markdown文件中使用。

我做错了什么?

有没有人有其他建议如何实现我的目标?

我正在使用最新发布的Doxygen 1.8.5。 Doxygen手册没有说明这一点。

这个问题与this有一些相似之处,但是从代码的角度来看这个问题。

1 个答案:

答案 0 :(得分:2)

看来我没有做错任何事。 This answer,对于一个相关的问题,显示Doxygen 1.8.5对于降价页面根本不支持此功能,但是在'{{的Doxygen手册中尚未标记非功能性3}}'或'group'页面。