在Doxygen

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没有任何内容。为什么不呢？

Answer 1

答案与为什么functions和preprocessor definitions的条目不会自动生成的答案相同。

Doxygen将别名，变量，函数和宏（但不是类或名称空间）视为对象＆＃39;。所有对象都是＆＃39;记录 iff 还记录了它们的包含文件，类或命名空间。

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

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

您文件的全局范围内的任何位置。