在Doxygen中记录C++别名

Question

在适当的注释前，Doxygen会为class、struct和namespace声明生成条目，但不包括typedef或using的出现。

在这个例子中：

/// here is my typedef
typedef int MyTypedef;

/// here is my namespace
namespace MyNamespace 
{
  /// here is my other typedef
  typedef int MyOtherTypedef;
}

我在文档中找到了 MyNamespace 和 MyOtherTypedef 的条目，但是没有 MyTypedef 的条目。为什么？

- John McFarlane

Answer 1

答案与为什么functions和预处理器定义的条目不会自动生成的答案相同。

Doxygen认为别名、变量、函数和宏（但不包括类或命名空间）是“对象”。只有包含它们的文件、类或命名空间也被记录，才能记录所有“对象”。

要在文档中显示MyTypedef，请添加：

/// \file
/// here is my file

在你的文件的全局范围内的任何地方。

- John McFarlane