什么应该放在Doxygen的“模块”或“组”中?

时间:2014-01-29 14:06:46

标签: doxygen

这类似于this question,但稍微具体一点。组或模块中的预期元素是什么?如果我将整个文件包含@file构造,则该文件仍会列在全局文件部分中。如果我不这样做,它会更有意义,但仍然没有概要,描述模块的详细文本已经消失。即使有详细文本,它也不在顶部,很难找到。对它的引用不是详细信息部分,而是转到模块。我开始相信它必须用于其他目的。我的问题是目的是什么?打算将什么东西放到一个小组中?

1 个答案:

答案 0 :(得分:0)

Doxygen Groups经常错过的价值是,它们使您能够(在您的文档中)将与逻辑相关但在代码中分开的内容整合在一起。

考虑你有两个模块/类/什么。一个是,一个是水果。每个都是一个单独的代码模块,应该这样保存,并在doxygen输出中进行描述。

但是,您想要向用户提供有关如何创建水果碗的一些指导。

通过在Bowl和Fruit中的代码的相关部分中使用ingroup Fruitbowls,生成的文档会自动描述Fruit,Bowls, Fruitbowls所需的内容,而无需其他文本(除了\defgroup fruitbowls允许你在某处介绍水果和碗等水果碗的组装,等等。

本质上,组是一种将共享逻辑用途的代码段聚集在一起的方式,而不是代码结构(即模块)。