在一页上合并文档片段

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 

/**
 * @}
 */

这会产生一个名为“模块”的选项卡，其中每个组都被列为具有自己页面的“模块”。如果您想将整个文件文档添加到组中，请确保您还使用@{ 和@} 标记将@file 标记。