Documentation 强氧分组

Documentation 强氧分组,documentation,doxygen,Documentation,Doxygen,我有一个关于doxygen中的页面和组的问题。我有一个项目,我用@defgroup和@ingroup cmds对类等进行分组。到目前为止,这一切都很好 现在我想用降价页面向项目中添加特殊文档。这些页面应显示在专用模块(组)中。我尝试使用@page和@subpage cmds创建页面。这很好,但是页面在菜单中显示得很简单 因此,我尝试将它们添加到带有@ingroup的组中。但这并不像我猜的那样有效。是否可以向模块(组)添加页面 结果应该如下所示: Project |-- Modules | |--

我有一个关于doxygen中的页面和组的问题。我有一个项目,我用@defgroup和@ingroup cmds对类等进行分组。到目前为止,这一切都很好

现在我想用降价页面向项目中添加特殊文档。这些页面应显示在专用模块(组)中。我尝试使用@page和@subpage cmds创建页面。这很好,但是页面在菜单中显示得很简单

因此,我尝试将它们添加到带有@ingroup的组中。但这并不像我猜的那样有效。是否可以向模块(组)添加页面

结果应该如下所示:

Project
|-- Modules
| |-- "Module1"
| | |-- documentation page1 (from *.md file)
| | |-- class documentation
| |-- "Module2"
| | |-- documentation page2
| | |-- class documentation
/** @defgroup app Main Application */

/** @addtogroup app
  * @brief Main application description.
  *
  * @{
  */

int main() { return 0; } //do nothing

/** @} */

我希望你能帮助我

我使用{和}命令完成了它,它的工作原理是这样的-

/**  
 * @defgroup module_name Sample Module   
 * @{   
 *     @page page_name [Optional Page Heading]   
 *     here will be the texts for the page ...    
 * @}   
 */   
如果已经在其中定义了模块,可能需要使用@addtogroup而不是@defgroup


希望这能有所帮助。

在上述案例中,我们有两种类型的组文档:

  • 源文件中的文档
  • 来自降价文件的文档
  • 我们需要为这个goups创建树结构

    例如,我们创建了两个组:

  • 带有源代码文档的主应用程序
  • 文件Library.md中包含文档的库
  • 主应用程序组源代码(适用于C++)可能如下所示:

    Project
    |-- Modules
    | |-- "Module1"
    | | |-- documentation page1 (from *.md file)
    | | |-- class documentation
    | |-- "Module2"
    | | |-- documentation page2
    | | |-- class documentation
    
    /** @defgroup app Main Application */
    
    /** @addtogroup app
      * @brief Main application description.
      *
      * @{
      */
    
    int main() { return 0; } //do nothing
    
    /** @} */
    
    标记文件library.md包含简单文本:

    Library File {#library}
    ============
    
    Library Page Content from library.md.
    
    现在,为了定义结构,我们创建mainpage.md文件,其中包含以下内容:

    Pages {#mainpage}
    ============
    
    Content:
    
    - @subpage library
    
    @defgroup Library
    @addtogroup Library
    @copydoc library
    @{
    @}
    
    mainpage.md中的
    @subpage
    标记用于将树中的所有页面隐藏到一个根项目(页面)。
    @defgroup
    标记为降价文档创建新组。
    @copydoc
    标记将内容从库页面复制到库组

    在屏幕截图上,您可以看到结果结构:

    注意,在这种情况下,模块组名称和页面名称可能不同。您还可以使用
    @copydoc
    标记将标记文件中的内容粘贴到源代码文档中

    参考: