Doxygen:空详细说明 [英] Doxygen: Empty Detail Description

查看:105
本文介绍了Doxygen:空详细说明的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

上下文-Doxygen工具,使用C代码生成RTF文档。

Context - Doxygen tool on C codes to generated RTF documents.

在模块/组的文档中,即使没有,也会得到标题详细说明在某些特定的模块/组中提供了详细说明。

In the documentation of Modules/Groups, we are getting the header "Detailed Description" even if no detail description is provided for some particular module/group.

在生成的RTF文档中,这看起来很难看。

In generated RTF document this looks ugly. Is it possible to get rid of this empty Detail Description sections?

我尝试了 ALWAYS_DETAILED_SEC = NO ,但是有可能摆脱这种空的详细描述部分吗?不管用。我不能执行 HIDE_UNDOC_MEMBERS = YES ,因为组/模块包含已记录的成员(结构,函数...)。

I tried "ALWAYS_DETAILED_SEC = NO" but it is not working. I cannot do "HIDE_UNDOC_MEMBERS = YES" as the group/module contains members (struct, functions ...) which are documented.

推荐答案

即使实体(模块/组等)中没有文档,生成详细说明的原因也是因为Doxyfile标记 EXTRACT_ALL 设置为 YES

The reason as to why "Detailed Description" gets generated even if there is no Documentation in the Entities (Modules/Groups, etc..) is because the Doxyfile tag EXTRACT_ALL is set to YES.

通过设置,


  • EXTRACT_ALL =

  • ALWAYS_DETAILED_SEC =

  • EXTRACT_ALL = NO
  • ALWAYS_DETAILED_SEC = NO

只有记录有Doxygen特殊注释的实体才会被记录。并且只有那些具有@details->详细说明的实体才会在详细说明部分下列出。

Only the entities documented with Doxygen special comments will get Documented. And only those entities having @details -> Detailed description will be listed under the Detailed Description section.

这篇关于Doxygen:空详细说明的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆