【问题标题】:How do I configure Doxygen to generate docs for only one file?如何配置 Doxygen 只为一个文件生成文档?
【发布时间】:2020-06-17 12:47:34
【问题描述】:

我想为一个非常大的项目的单个 Java 类生成文档。我怎么做?我很确定几年前我做到了。它有很多依赖项,所以我不能只是将类复制到另一个目录。

我可以使用命令行或 OS X Doxywizard。

【问题讨论】:

    标签: java doxygen


    【解决方案1】:

    当您想使用 doxygen 仅从一个文件生成文档时,例如 aa.java 可以使用普通的 doxygen 配置文件并在其中设置:

    INPUT = aa.java
    

    取决于文件aa.java 中的所有内容,您可能必须使用

    EXCLUDE_SYMBOLS = 
    

    还有

    参见(摘自 doxygen 手册,http://doxygen.nl/manual):

    • 输入:http://doxygen.nl/manual/config.html#cfg_input

      INPUT 标记用于指定包含文档源文件的文件和/或目录。您可以输入像 myfile.cpp 这样的文件名或像 /usr/src/myproject 这样的目录。

    • EXCLUDE_SYMBOLS:http://doxygen.nl/manual/config.html#cfg_exclude_symbols

      EXCLUDE_SYMBOLS 标记可用于指定应从输出中排除的一个或多个符号名称(命名空间、类、函数等)。符号名称可以是完全限定名称、单词,或者如果使用通配符 *,则可以是子字符串。示例:ANamespace、AClass、AClass::ANamespace、ANamespace::*Test

    【讨论】:

      猜你喜欢
      • 2012-12-18
      • 2012-03-26
      • 2014-08-09
      • 2015-10-26
      • 2014-09-09
      • 2016-12-07
      • 2018-12-09
      • 2014-05-01
      • 2014-05-18
      相关资源
      最近更新 更多