枚举类中的枚举类的Doxygen文档

时间:2018-03-26 21:13:05

标签: doxygen

我试图为枚举类添加文档,该枚举类位于自己的头文件中。以下是我到目前为止所做的事情

function generateMatrix (n) {
  let result = [];
  for (var i = 0; i < n; i++) {
    result.push([]);
    for (var j = 0; j < n; j++) {
      result[i].push(null);
    }
  }
  return result;  
}
console.log(generateMatrix(3));

由于某种原因,生成的doc会在列表中显示这3个枚举成员,但是当我单击它们时,它不会生成具有自己描述的页面。然而,当我将这个枚举类放在另一个类中时,这很有用。 谁能帮助我发现我失踪的东西?感谢。

1 个答案:

答案 0 :(得分:1)

来自Doxygen documentation

  

要记录C ++类的成员,还必须记录该类   本身。名称空间也是如此。记录全球C   首先必须是function,typedef,enum或preprocessor定义   记录包含它的文件(通常这将是一个标题   file,因为该文件包含导出的信息   其他源文件)。

因此,如果您记录foo命名空间,一切正常:

/**
@brief Namespace foo
*/
namespace foo {

/**
@brief My enum
*/
enum class MyEnum{
    /**
     This is ENUM_A
    */
    ENUM_A,
    /**
     This is ENUM_B
    */
    ENUM_B,
    /**
     This is ENUM_C
    */
    ENUM_C
};
}

首先点击命名空间,然后点击foo,然后点击您的枚举文档。

<强>更新

正如@albert指出的,还有另一种方法。根据{{​​3}},

  

如果EXTRACT_ALL标记设置为YES,则doxygen将全部假设   即使没有文档,也会记录文档中的实体   可用。私有类成员和静态文件成员将是   隐藏,除非设置了EXTRACT_PRIVATEEXTRACT_STATIC标记   到YES

如果你的代码库中有很多这样的场景,这是一个不错的选择。