documentation - Doxygen:空详细说明

Question

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

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

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

我试过"ALWAYS_DETAILED_SEC = NO"但它不工作。我做不到"HIDE_UNDOC_MEMBERS = YES"因为组/模块包含记录的成员(结构，函数...)。

Answer 1

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

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

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

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

现在设置visible="yes"至visible="no"在 briefdescription field 。在文件底部附近，您将看到 <detaileddescription title=""/>将此移动到顶部、上方或下方 briefdescription .你现在应该有:

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

请注意，我已通过填写标题字段将标题更改为“描述”。保存文件。现在在您的 Doxyfile 中，您需要指定一个自定义布局文件。添加以下行(或搜索并填写):LAYOUT_FILE=DoxygenLayout.xml
假设您的路径是正确的等，您现在应该将带有简短描述的组页面替换为完整描述。