为什么在 javadoc 生成过程中 Maven 安装失败？

Question

运行“maven install”时，我得到以下信息..

[信息] [javadoc:javadoc {执行: 默认}] [信息] -------------------------------------------------- ---------------------- [错误] 构建错误 [信息] -------------------------------------------------- ---------------------- [信息] 发生错误 JavaDocs 报告生成：退出代码： 1 - java.lang.NullPointerException 在 com.sun.tools.doclets.formats.html.PackageUseWriter.generatePackageUse(PackageUseWriter.java:180) 在 com.sun.tools.doclets.formats.html.PackageUseWriter.generatePackageList(PackageUseWriter.java:124) 在 com.sun.tools.doclets.formats.html.PackageUseWriter.generatePackageUse(PackageUseWriter.java:110) 在 com.sun.tools.doclets.formats.html.PackageUseWriter.generatePackageUseFile(PackageUseWriter.java:99) 在 com.sun.tools.doclets.formats.html.PackageUseWriter.generate(PackageUseWriter.java:78) 在 com.sun.tools.doclets.formats.html.ClassUseWriter.generate(ClassUseWriter.java:116) 在 com.sun.tools.doclets.formats.html.HtmlDoclet.generateOtherFiles(HtmlDoclet.java:92) 在 com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:122) 在 com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64) 在 com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42) 在 com.sun.tools.doclets.standard.Standard.start(Standard.java:23) 在 sun.reflect.NativeMethodAccessorImpl.invoke0(Native 方法） 在 sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) 在 sun.reflect.DelegatingMethodAccessorImpl.invoke（DelegatingMethodAccessorImpl.java:25） 在 java.lang.reflect.Method.invoke(Method.java:597) 在 com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269) 在 com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143) 在 com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340) 在 com.sun.tools.javadoc.Start.begin(Start.java:128) 在 com.sun.tools.javadoc.Main.execute(Main.java:41) 在 com.sun.tools.javadoc.Main.main(Main.java:31)

命令行为： /home/fsl/jdk1.6.0_12/jre/../bin/javadoc @options @packages @argfile

我做错了什么？

Answer 1

另外，如果您有：

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (default-cli) on project coolproject-api: MavenReportException: Error while creating archive:
[ERROR] Exit code: 1 - javadoc: warning - No source files for package org.coolproject.api
[ERROR] javadoc: warning - No source files for package org.coolproject.api
[ERROR] javadoc: warning - No source files for package org.coolproject.api.listeners
[ERROR] javadoc: error - No public or protected classes found to document.

Java 编译器可以理解具有包样式名称的源目录，例如：

coolproject-api/java/org.coolproject.api/

并且没有任何问题，但 maven-javadoc-plugin 不会。 因此，尝试将您的“物理”包布局更改为：

coolproject-api/java/org/coolproject/api/

Answer 2

要删除 maven-javadoc-plugin 中的 -use 选项，请使用以下配置：

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <configuration>
                <use>false</use>
                <links>
                    <link>http://java.sun.com/javase/6/docs/api/</link>
                </links>
            </configuration>
        </plugin>

Answer 3

有一个未修复的错误似乎是您的问题。 从 bug 描述来看，已知的解决方法是删除 -use 选项或使用 JDK 1.4.2。 您使用的是 Java 6，因此可能是这种情况。

发生 NullPointerException 的行是：

printHyperLink("", pkg.name(), Util.getPackageName(pkg), true);

那么问题可能是由于 package.html 文件中的拼写错误而发生的？

Answer 4

从该错误报告来看，当默认包中有类并且 -use 处于打开状态时，就会发生这种情况。 因此，一种解决方案是将默认包中的类移动到命名包中。

令人烦恼的是，某些发行版（例如 MacOS X Lion）附带的 javadoc 工具中尚未修复此错误。

该错误似乎已在 openjdk 6 中修复，至少从源代码检查来看是这样。 该源代码的下载地址：http://download.java.net/openjdk/jdk6/

Answer 5

查看您的环境变量并删除 CLASSPATH 变量或添加您的包路径。

javadoc 使用类路径来确定包。 如果路径不在您的变量中，它将失败。