Doxygen：空详细说明

Question

Context - C代码上的Doxygen工具生成RTF文档。

在模块/组的文档中，即使没有为某个特定模块/组提供详细描述，我们也会得到标题“详细描述”。

在生成的RTF文档中，这看起来很难看。是否有可能摆脱这个空的详细描述部分？

我尝试了"ALWAYS_DETAILED_SEC = NO"，但它无法正常工作。我不能做"HIDE_UNDOC_MEMBERS = YES"，因为组/模块包含记录的成员（结构，函数...）。

Answer 1

即使实体（模块/组等）中没有文档也会生成“详细描述”的原因是因为Doxyfile标记EXTRACT_ALL设置为YES。

通过设置，

• EXTRACT_ALL = NO
• ALWAYS_DETAILED_SEC = NO

只有使用Doxygen特殊注释记录的实体才会获得记录。只有具有@details - >详细描述的实体才会列在详细说明部分下。

Answer 2

不幸的是，如果类已记录如下，则不会生成：

/// <summary>
/// This is..
/// </summary>
class ABC
{     
}

删除'summary'标签，即它应该是

///
/// This is..
///
class ABC
{

}

在qazxsw poi下面的链接中搜索详细描述（在开头）

Answer 3

这可能有点晚了，但其他人可能会感兴趣（我当时）。

您可以使用布局文件完全删除组详细描述，但如果您有简要说明，仍将创建http://www.star.bnl.gov/public/comp/sofi/doxygen/docblocks.html链接（链接到任何内容）。我的解决方案是对组的禁用简要描述，并将详细描述移到页面顶部（基本上替换它）。

通过运行以下命令More...创建布局文件。创建默认布局文件。我们感兴趣的部分是靠近底部的群组：

dOxygen -l

现在将

<!-- Layout definition for a group page -->
  <group>
    <briefdescription visible="yes"/>
    <groupgraph visible="$GROUP_GRAPHS"/>

设置为visible="yes"字段中的visible="no"。在文件底部附近你会看到一个briefdescription将它移动到顶部，在<detaileddescription title=""/>之上或之下。你现在应该：

briefdescription

请注意，我已通过填写标题字段将标题更改为“描述”。保存文件。现在在Doxyfile中，您需要指定自定义布局文件。添加以下行（或搜索并填写）：

<!-- Layout definition for a group page -->
  <group>
    <briefdescription visible="no"/>
    <detaileddescription title="Description"/>
    <groupgraph visible="$GROUP_GRAPHS"/>

假设您的路径正确等，您现在应该将具有简要描述的组页面替换为完整描述。