Doxygen 将文档片段整合到一个页面上
我想将文档片段合并到一个页面上 我的用例是我有两个不同的源模块,我想在其中放置一个doxygen片段。然后在第三个源模块中,我想放置一个引用片段的@page 我希望在生成文档时,我会看到这5个片段合并到一个.html页面上 页面/子页面系统无法工作,因为这只会在页面上放置指向文档片段的链接。我想把这些片段整合到一页上 这是第一个.c文件:Doxygen 将文档片段整合到一个页面上,doxygen,Doxygen,我想将文档片段合并到一个页面上 我的用例是我有两个不同的源模块,我想在其中放置一个doxygen片段。然后在第三个源模块中,我想放置一个引用片段的@page 我希望在生成文档时,我会看到这5个片段合并到一个.html页面上 页面/子页面系统无法工作,因为这只会在页面上放置指向文档片段的链接。我想把这些片段整合到一页上 这是第一个.c文件: /*! @setfrag FRAG1 ** this is some text for fragment 1 */ 这是第二个文件: /*! @setfra
/*! @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
*/
我不确定我是否正确理解了你的问题,但这正是分组的作用。您可以使用标记@defgroup groupname描述定义组,然后使用标记@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标记