首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >当Javadoc标记不完整时,Maven在Java 8中不起作用

当Javadoc标记不完整时,Maven在Java 8中不起作用
EN

Stack Overflow用户
提问于 2013-04-09 02:23:37
回答 18查看 197.4K关注 0票数 331

自从我使用Maven以来,我已经能够在我的本地存储库项目中构建和安装具有不完整的Javadoc标记(例如,缺少参数)的项目。

然而,自从我迁移到Java8 (1.8.0-ea-b90)后,Maven对于缺少文档标签是绝对严格的,并且当我尝试构建或安装一个Javadoc不是“完美”的项目时,它会向我显示许多与Javadoc问题相关的Javadoc错误。我试图在本地存储库中编译和安装的一些项目是我无法控制的第三方项目。因此,在我的场景中,仅仅修复所有这些项目中的所有Javadoc似乎并不可行。

这是我在项目中执行mvn clean package install时看到的一小部分输出:

代码语言:javascript
运行
复制
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9.026s
[INFO] Finished at: Mon Apr 08 21:06:17 CEST 2013
[INFO] Final Memory: 27M/437M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar (attach-javadocs) on project jpc: MavenReportException: Error while creating archive:
[ERROR] Exit code: 1 - /Users/sergioc/Documents/workspaces/heal/jpc/src/main/java/org/jpc/engine/prolog/PrologDatabase.java:10: error: @param name not found
[ERROR] * @param terms the terms to assert
[ERROR] ^
[ERROR] /Users/sergioc/Documents/workspaces/heal/jpc/src/main/java/org/jpc/engine/prolog/PrologDatabase.java:11: warning: no description for @return
[ERROR] * @return
[ERROR] ^

在我的POM中,Javadoc Maven插件的配置如下:

代码语言:javascript
运行
复制
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

正如我之前所说的,如果我回到Java 7,一切都很好。也许这是一个与在Java 8中运行的Maven有关的bug?我如何让它在Java 8中工作(例如,能够构建项目的Javadoc并将其代码安装到我的本地存储库中)?我已经在OSX中使用Maven 3.0.3和3.0.5进行了测试。

更新:

如果我用<failOnError>false</failOnError>更改了我的Javadoc插件配置(谢谢马丁):

代码语言:javascript
运行
复制
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

然后将该项目安装到我的本地存储库中。但是,Javadoc JAR仍然没有生成。

我在控制台中看到的这个新配置的输出片段是:

ERROR MavenReportException:创建存档时出错:退出代码:1- /Users/....java:18: warning: no @param...命令行是: /Library/Java/Home/bin/javadoc @options @packages

请参考'/Users/sergioc/Documents/workspaces/heal/minitoolbox/target/apidocs‘目录中生成的Javadoc文件。

at org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeJavadocCommandLine(AbstractJavadocMojo.java:5043) at org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeReport(AbstractJavadocMojo.java:1990) at org.apache.maven.plugin.javadoc.JavadocJar.execute(JavadocJar.java:181) at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:101) at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:209) atorg.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:153) at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:145) at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:84) at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:59) at org.apache.maven.lifecycle.internal.LifecycleStarter.singleThreadedBuild(LifecycleStarter.java:183) atorg.apache.maven.lifecycle.internal.LifecycleStarter.execute(LifecycleStarter.java:161)在org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:320)在org.apache.maven.DefaultMaven.execute(DefaultMaven.java:156)在org.apache.maven.cli.MavenCli.execute(MavenCli.java:537)在org.apache.maven.cli.MavenCli.doMain(MavenCli.java:196)在org.apache.maven.cli.MavenCli.main(MavenCli.java:141) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:491) at org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced(Launcher.java:290) at org.codehaus.plexus.classworlds.launcher.Launcher.launch(Launcher.java:230)在org.codehaus.plexus.classworlds.launcher.Launcher.main(Launcher.java:352)的org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode(Launcher.java:409)

在使用Java7时,如何在一个步骤中构建源代码、安装项目并生成Javadoc JAR,有什么解决方法吗?

EN

回答 18

Stack Overflow用户

回答已采纳

发布于 2013-05-25 04:28:39

最好的解决方案是修复javadoc错误。如果由于某些原因(例如:自动生成的源代码)不可能这样做,那么您可以禁用此检查。

DocLint is a new feature in Java 8,概括为:

提供了一种方法,可以在开发周期的早期检测Javadoc注释中的错误,并且可以很容易地链接回源代码。

这在默认情况下是启用的,并且将在生成Javadoc之前运行大量检查。您需要根据指定的in this thread为Java8关闭此功能。您必须将以下内容添加到maven配置中:

代码语言:javascript
运行
复制
<profiles>
  <profile>
    <id>java8-doclint-disabled</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>
    <properties>
      <javadoc.opts>-Xdoclint:none</javadoc.opts>
    </properties>
  </profile>
</profiles>
<build>
  <plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.9</version>
        <executions>
            <execution>
                <id>attach-javadocs</id>
                <goals>
                    <goal>jar</goal>
                </goals>
                <configuration>
                    <additionalparam>${javadoc.opts}</additionalparam>
                </configuration>
            </execution>
        </executions>
    </plugin>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.3</version>
        <configuration>
          <reportPlugins>
            <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-javadoc-plugin</artifactId>
              <configuration>
                <additionalparam>${javadoc.opts}</additionalparam>
              </configuration>
            </plugin>
          </reportPlugins>
        </configuration>
      </plugin>
   </plugins>
</build>

用于maven-javadoc-的插件替换:3.0.0+

代码语言:javascript
运行
复制
<additionalparam>-Xdoclint:none</additionalparam>

使用

代码语言:javascript
运行
复制
<doclint>none</doclint>
票数 408
EN

Stack Overflow用户

发布于 2014-03-10 17:16:28

让java8和java7都能工作的最简单的方法是在构建中使用一个概要文件:

代码语言:javascript
运行
复制
<profiles>
  <profile>
    <id>doclint-java8-disable</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>

    <build>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-javadoc-plugin</artifactId>
          <configuration>
            <additionalparam>-Xdoclint:none</additionalparam>
          </configuration>
        </plugin>
      </plugins>
    </build>
  </profile>
</profiles>
票数 99
EN

Stack Overflow用户

发布于 2014-11-08 00:50:54

这是我所知道的忽略doclint警告的最简明的方法,而不管使用的是什么java版本。只需稍加修改,即可在多个配置文件中重复配置插件。

代码语言:javascript
运行
复制
<profiles>
  <profile>
    <id>doclint-java8-disable</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>
    <properties>
      <javadoc.opts>-Xdoclint:none</javadoc.opts>
    </properties>
  </profile>
</profiles>

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>2.9.1</version>
      <executions>
        <execution>
          <id>attach-javadocs</id> <!-- The actual id should be apparent from maven output -->
          <configuration>
            <additionalparam>${javadoc.opts}</additionalparam>
          </configuration>
        </execution>
      </executions>
    </plugin>
    ...
  </plugins>
</build>

在oracle/open jdk 6、7、8和11上进行了测试。

票数 66
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/15886209

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档