Doxygen：空的详细信息描述

上下文 - 用C代码生成RTF文档的Doxygen工具。Doxygen：空的详细信息描述

在模块/组的文档中，即使没有为某些特定模块/组提供详细描述，我们也会得到标题“详细描述”。在生成的RTF文件上，这看起来很难看。是否有可能摆脱这个空的详细说明部分？

我试过“ALWAYS_DETAILED_SEC = NO”，但它不起作用。我不能做“HIDE_UNDOC_MEMBERS = YES”，因为组/模块包含有文档记录的成员（struct，functions ...）。

感谢， Aritra

2013-03-05 Aritra Mukherjee

不幸的是，如果类已经被记录在案喜欢它不产生：

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

删除 '摘要' 标签，也就是说，它应该像

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

}

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

来源

2013-05-28 17:44:19

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

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

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

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

现在在briefdescription字段设置visible="yes"到visible="no"。在文件底部附近，您会看到一个<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

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

来源

2014-06-30 16:48:46 bhimberg

的原因，为什么“详细描述”获取生成即使在没有实体文件（模块/组，等等）是因为标签的Doxyfile EXTRACT_ALL 设置为YES。

通过设置，

EXTRACT_ALL = NO
ALWAYS_DETAILED_SEC = NO

只有Doxygen的特别注释中记录实体将得到记录。只有具有@details - >详细描述的实体才会在详细描述部分下列出。

来源

2015-03-22 21:02:12 user3598862

Doxygen：空的详细信息描述

回答

相关问题