4

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

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

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

我试过"ALWAYS_DETAILED_SEC = NO"了，但它不工作。我不能这样做"HIDE_UNDOC_MEMBERS = YES"，因为组/模块包含已记录的成员（结构、函数 ...）。

4

3 回答 3

2

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

通过设置，

  • EXTRACT_ALL =否
  • ALWAYS_DETAILED_SEC =否

只有使用 Doxygen 特殊注释记录的实体才会被记录。只有那些具有@details -> 详细描述的实体才会在详细描述部分下列出。

于 2015-03-22T21:02:12.457 回答
2

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

您可以使用布局文件完全删除组详细描述，但如果您有简短描述，More...仍会创建一个链接（链接到任何内容）。我的解决方案是禁用组的简要说明，并将详细说明移到页面顶部（基本上是替换它）。

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

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

现在设置visible="yes"为visible="no"在briefdescription现场。在文件底部附近，您会看到一个<detaileddescription title=""/>Move this to the top, above or below briefdescription。你现在应该有：

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

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

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

于 2014-06-30T16:48:46.437 回答
1

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

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

删除“摘要”标签，即应该像

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

}

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

于 2013-05-28T17:44:19.667 回答