Doxygen - 没有命名空间中函数的详细描述

时间:2014-08-17 07:31:49

标签: c++ doxygen

我试图让doxygen 1.8.7在HTML输出中包含详细说明。例如,给定以下文件:

/** \file iniparse.h */

namespace ini {
/** \brief A brief description.
 *
 * A longer description.
 */
inline void parse() {}
}

我的iniparse.h的HTML包含一个ini :: parse的条目,带有文本"简要说明。更多..." "更多......" part是指向同一页面中不存在的锚点的断开链接。文字"更长的描述"在生成的HTML中无处可见。

如果我摆脱了命名空间并且只是在任何命名空间之外定义了一个函数解析(即::parse),那么事情就可以了。有人能告诉我如何在命名空间内获得相同的行为吗?感谢。

1 个答案:

答案 0 :(得分:1)

原来这个问题是由三件事组合引起的。首先,doxygen中一个普通的老bug:

https://bugzilla.gnome.org/show_bug.cgi?id=745481

其次,即使修复了错误,您也需要生成名称空间页面,否则您仍会得到损坏的链接。因此,您需要在Doxyfile中使用> glob2rx("A?????AF") [1] "^A.....AF$"

第三,除非你有EXTRACT_ALL = YES,否则你必须通过附加Doxygen注释来确保命名空间本身。所以你需要:

SHOW_NAMESPACES = YES

一方面,如果您需要文档的内容,可能需要记录命名空间。但是,即使没有命名空间文档,doxygen也会显示文档的第一部分,这很奇怪。所以我认为这仍然是一个错误,但至少我知道如何解决它。