Question

我想在一个页面上整合文档片段。

我的用例是我有两个不同的源模块，我想放置一个doxygen片段。然后在第三个源模块中，我想放一个引用片段的@page。

我希望在生成文档时，我会看到这5个片段合并到一个.html页面上。

页面/子页面系统不起作用，因为它只是将页面上的链接放到文档片段中。我希望将片段合并到一个页面上。

这是第一个.c文件：

/*! @setfrag FRAG1
** this is some text for fragment 1
*/

这是第二个档案：

/*! @setfrag FRAG2
** This is some text for fragment 2.
*/

这是第三个档案：

/*! @page SOMEPAGE Page demonstrates consolidating fragments.
** @getfrag FRAG1
** @getfrag FRAG2
*/

Answer 1

我不确定我是否理解你的问题，但这应该是分组所做的。您可以使用标记@defgroup groupname description定义“组”，然后使用标记@addtogroup groupname将片段添加到组中。然后你可以在任何文件中定义你的组（例如你可以创建一个单独的文件“groups.dox”）：

/**
 * @defgroup myGroup My Group
 * @brief A brief description of \"My Group\"
 * @details A more detailed description of \"My Group\".
 */

您可以通过将以下内容添加到文件中来将片段或完整文件添加到该组：

/**
 * @addtogroup myGroup
 * @{
 */

// any contents you want to add to the group 

/**
 * @}
 */

这会生成一个名为“Modules”的选项卡，其中每个组都被列为具有自己页面的“模块”。如果要将整个文件文档添加到组中，请确保将@file标记与@{和@}标记括起来。

在一个页面上整合文档碎片

1 个答案: