You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何让Doxygen模块目录表显示@defgroup的模块描述?

问题描述

我按如下方式组织Doxygen代码注释:

头文件

/**
 * @defgroup  alternator_controller Alternator Controller
 * @ingroup   application_layer
 * @file      alternator_controller.h
 * @{
 */
 
 /* Header code */

 /**@}*/

源文件

/**
 * @ingroup   alternator_controller
 * @file      alternator_controller.c
 *
 */

生成的索引目录中,我希望在组名称旁显示组描述(替换图中红色文字位置的内容),但尝试在多个位置添加@brief都无效:

/**
 * @defgroup  alternator_controller Alternator Controller
 * @ingroup   application_layer
 * @file      alternator_controller.h
 * @brief DESCRIPTION HERE IS NOT DISPLAYED
 * @{
 * @brief DESCRIPTION HERE IS ALSO NOT DISPLAYED
 */
  
  /* Header code */

  /**@}*/

请问是否有办法实现该需求?


解决方案

Doxygen 中,@defgroup 的组描述不需要通过 @brief 来定义,直接在 @defgroup 命令所在的注释块中写入描述文本即可,Doxygen 会自动将这部分内容识别为组的描述并显示在索引中。

修改后的头文件注释示例:

/**
 * @defgroup  alternator_controller Alternator Controller
 * @ingroup   application_layer
 * @file      alternator_controller.h
 * 这里直接写入组的描述内容,比如:负责控制发电机的电压调节与启停逻辑,属于应用层核心模块
 * @{
 */
 
 /* Header code */

 /**@}*/

原理说明:Doxygen 对 @defgroup 注释块的处理逻辑是,忽略命令标签后,剩余的普通文本会被作为组的描述信息,@brief 标签在这里不生效,因为它主要用于函数、结构体、文件等元素的简短描述,而非模块组。


内容的提问来源于stack exchange,提问作者Ricard Molins

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.31 11:40:58