【问题标题】:Doxygen groups and modules indexDoxygen 组和模块索引
【发布时间】:2011-02-02 10:33:16
【问题描述】:

我正在为我的项目创建一个 Doxygen 文档。最近,我使用\addtogroup标签对相关类进行了分组。在此之后,我的文档中有一个模块选项卡。它显示所有模块。我想在同一页面上模块名称下方的模块名称下方添加一些描述。我怎样才能使用 Doxygen 呢?

这是我的标签

/*! \addtogroup test test
 *  Test Testing a group in doxygen
 *  @{
 */

【问题讨论】:

    标签: c++ doxygen doxygen-addtogroup


    【解决方案1】:

    您必须编写一个仅包含 cmets 的专用 .h 文件。 为每个组定义如下评论:

    /** @defgroup FooGroup
     *
     * This module does yada yada yada
     *
     */
    

    然后您将定义分配给组(即使在不同的文件上),如下所示:

    /** @addtogroup FooGroup */
    /*@{*/
    
    /** Summon a goat
     *
     * @param name The name of the goat;
     * @return The summoned goat;
     */
    Goat summon_goat (const char *name);
    
    ...
    ...
    
    /*@}*/
    

    编辑

    this 也是如此。 见“详细说明”?您还可以在 @verbatim@endverbatim 命令中添加代码 sn-p 和示例。

    【讨论】:

    • “召唤一只山羊”让我崩溃了。顺便说一句,截至 2011 年 9 月 28 日,SourceForge 链接似乎已断开。
    • 请注意,您不需要单独的头文件来执行此操作。您可以将@defgroup@addtogroups 放在同一个文件中,或者根本没有@defgroup,只需将文本放入@addtogroup 块之一(它们的工作方式与@defgroup 相同)这)。诀窍是,为了让文本显示在模块页面的顶部(以及模块索引页面),它需要是简要说明(即@brief),而其他任何内容都将显示在“详细说明”下" 再往下。
    • 我看到这个答案已经过时了 - 但仍然是我刚刚搜索的答案。太糟糕了,您的示例链接似乎已经烂了。你能把它作为snippet插入页面吗?
    猜你喜欢
    • 2013-01-21
    • 1970-01-01
    • 2012-07-19
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多