Doxygen和package.html

时间:2011-09-09 23:45:35

标签: package javadoc doxygen

根据javadoc规范,我在相关包的根目录中放置了一个名为package-info.html的文档文件。但是,当我在该文件夹上运行Doxygen时,不会拾取此文件中的文档。如何告诉Doxygen将此文件用作包文档?我也尝试了旧的规范package.html,但这不起作用。

1 个答案:

答案 0 :(得分:3)

为Java包提供文档的新替代方法是使用名为package-info.java而不是package.html的文件。 (有意选择文件名不是有效的类名。)

它有不同的语法:

/**
 * any javadoc comments (including tags)
 */
package name;

这也是提供包注释的唯一方法(在package关键字之前注明,如果有的话)。

从您的评论到问题,看起来最新版本的Doxygen只能理解这个package-info.java,而不是旧的package.html文件。

我记得有一个模块系统被提议,然后会添加一个类似的module-info.java文件,但我现在在短暂的googleing之后找不到它。 (也许是JSR 294?)