【问题标题】:How do I get Doxygen to document a class defined in a C++ file?如何让 Doxygen 记录在 C++ 文件中定义的类?
【发布时间】:2012-06-15 20:39:15
【问题描述】:

我知道类应该在 hpp 文件中定义。公司惯例要求我将这个特定的类保存在 cpp 文件中。

Doxygen 正在解析有问题的 cpp 文件并在其中记录一些#defines,但完全跳过了课程。如何让 Doxygen 看到它?我可以在 doxyfile 或文件本身中添加一些内容吗?

【问题讨论】:

  • 您是否使用// @file 记录了 cpp 文件?
  • 您能告诉我们您是如何在 .cpp 文件中记录该类的吗?

标签: c++ doxygen


【解决方案1】:

来自位于此处的 Doxygen 文档:http://www.doxygen.nl/manual/config.html#config_build

我发现这两个选项应该会有所帮助:

EXTRACT_LOCAL_CLASSES
如果 EXTRACT_LOCAL_CLASSES 标记设置为 YES,则在源文件中本地定义的类(和结构)将包含在文档中。如果设置为 NO,则仅包含头文件中定义的类。对 Java 源没有任何影响。

EXTRACT_ANON_NSPACES
如果此标志设置为 YES,匿名命名空间的成员将被提取并作为名为“anonymous_namespace{file}”的命名空间出现在文档中,其中 file 将替换为包含匿名命名空间的文件的基本名称。默认匿名命名空间是隐藏的。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2010-12-13
    • 2016-05-07
    • 1970-01-01
    • 2010-12-15
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多