Doxygen 和 package.html

【问题标题】：Doxygen and package.htmlDoxygen 和 package.html
【发布时间】：2011-11-14 04:16:26
【问题描述】：

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

【问题讨论】：

【解决方案1】：

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

它有不同的语法：

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

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

从您的 cmets 到问题，看起来最近版本的 Doxygen 只理解这个 package-info.java，而不是旧的 package.html 文件。

我记得有人提出了一个模块系统，然后会添加一个类似的module-info.java 文件，但经过短暂的谷歌搜索后我现在找不到它。（也许是 JSR 294？）

【讨论】：