Question

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

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

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

我试过了"ALWAYS_DETAILED_SEC = NO"，但它没有用。我无法做"HIDE_UNDOC_MEMBERS = YES"，因为组/模块包含已记录的成员（结构，函数...）。

Answer 1

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

通过设置，

EXTRACT_ALL = 否
ALWAYS_DETAILED_SEC = 否

只有使用Doxygen特别评论记录的实体才会获得记录。只有那些拥有@details的实体 - ＆gt;详细说明将在详细说明部分列出。

Answer 2

不幸的是，如果类已记录为：

，则不会生成

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

删除'summary'标记，即它应该像

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

}

在下面的链接中搜索详细说明（在开头） http://www.star.bnl.gov/public/comp/sofi/doxygen/docblocks.html

Answer 3

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

您可以使用布局文件完全删除组详细说明，但如果您有简要说明，仍会创建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。你现在应该：

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

请注意，我已将标题更改为＆＃34;说明＆＃34;填写标题字段。保存文件。现在在Doxyfile中，您需要指定自定义布局文件。添加以下行（或搜索并填写）： LAYOUT_FILE=DoxygenLayout.xml

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

Doxygen：空详细说明

3 个答案: