Оскільки я використовую Maven, мені вдалося створити та встановити в своїх проектах локального сховища, які мають неповні теги Javadoc (наприклад, відсутній параметр).

Однак, оскільки я перейшов на Java 8 (1.8.0-ea-b90), Maven абсолютно суворо ставиться до відсутніх тегів документації та показує мені безліч помилок Javadoc, пов'язаних з проблемами Javadoc, коли я намагаюся створити або встановити проект, де Javadoc не є "досконалий". Деякі проекти, які я намагаюся скласти та встановити у своєму локальному сховищі, є сторонніми проектами, над якими я не маю контролю. Тож вирішення проблеми просто виправити всі Javadocs у всіх цих проектах не видається можливим для мого сценарію.

Це невелика частина результатів, які я бачу під час виконання mvn clean package installпроекту:

[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] ^

Плагін Javadoc Maven налаштований так у моїй POM:

<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. Можливо, це помилка, пов’язана з Maven, що працює в Java 8? Як я можу змусити його працювати (тобто вміти будувати Javadoc проекту та встановлювати його код у моєму локальному сховищі) з Java 8? Я тестував і Maven 3.0.3, і 3.0.5 в OSX.

ОНОВЛЕННЯ:

Якщо я зміню конфігурацію плагіну Javadoc <failOnError>false</failOnError>(спасибі Мартін):

<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>

Потім проект встановлюється в моєму локальному сховищі. Однак JAR Javadoc все ще не генерується.

Фрагмент виводу, який я бачу в консолі з цією новою конфігурацією:

[ПОМИЛКА] MavenReportException: Помилка під час створення архіву: Код виходу: 1 - /Users/....java:18: попередження: немає @param ... Командний рядок був: / Бібліотека / Java / Головна / bin / javadoc @options @packages

Зверніться до створених файлів Javadoc у розділі '/ Users / sergioc / Документи / робочі простори / heal / minitoolbox / target / apidocs' dir.

на org.apache.maven.plugin.javadoc.AbriefJavadocMojo.executeJavadocCommandLine (AbstractJavadocMojo.java:5043) at org.apache.maven.plugin.javadoc.AbriefJavadocMojo.executeReportMajova.oven.avachea990.pdf (AJJavache) .javadoc.JavadocJar.execute (JavadocJar.java:181) на org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo (DefaultBuildPluginManager.java:101) на org.apache.maven.lifecycle.internal.MojoEeccutor (MojoEeccutor) : 209) на org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:153) на org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:145) на org.apache. maven.lifecycle.internal.LifecycleModuleBuilder.buildProject (LifecycleModuleBuilder.java:84) на org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject (LifecycleModuleBuilder.java:59) на org.apache.maven.lifecycle.internal.LifecycleStarter.singleThreadedBuild (LifecycleStarter.java:183) на org.apache.maven.lifecycle.internal.LifecycleStarter.execute (LifecycleStarter.execute (LifecycleStarter.61) на 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) у sun.reflect.NativeMethodAccessorImpl.invoke0 ( Native Method) у sun.reflect.NativeMethodAccessorImpl.invoke (NativeMethodAccessorImpl.java:57) у sun.reflect.DelegatingMethodAccessorImpl.invoke (DelegatingMethodAccessorImpl.java:43) на java.lang.reflect.Method.викликати (Method.java:291) на org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced (Launcher.java:290) на org.codehaus.plexus.classworlds.launcher.Launcher.launch (Launcher.java:230) на org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode (Launcher.java:409) на org.codehaus.plexus.classworlds.launcher.Launcher.main (Launcher.java:352)

Будь-яке рішення щодо того, як створити джерела, встановити проект та генерувати JAR Javadoc за один крок, як це працювало з Java 7?

Найкращим рішенням було б виправити помилки javadoc. Якщо з якихось причин це неможливо (тобто: автоматично створений вихідний код), ви можете відключити цю перевірку.

DocLint - це нова функція Java 8 , яка узагальнена як:

Забезпечте засоби для виявлення помилок у коментарях Javadoc на початку циклу розробки та таким чином, що легко пов'язується з вихідним кодом.

Це ввімкнено за замовчуванням, і буде запущено багато перевірок перед генерацією Javadocs. Потрібно вимкнути це для Java 8, як зазначено в цьому потоці . Вам доведеться додати це до конфігурації Maven:

<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+: замініть

<additionalparam>-Xdoclint:none</additionalparam>

з

<doclint>none</doclint>

Найпростіший підхід для роботи з java 8 і java 7 - це використання профілю в збірці:

<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>

Ось найбільш стислий спосіб, який я знаю, щоб ігнорувати попередження про доклінт незалежно від версії Java, що використовується. Немає необхідності дублювати конфігурацію плагіна в декількох профілях з незначними модифікаціями.

<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.

Додайте до розділу глобальних властивостей у файл pom:

<project>
    ...
    <properties>
        <additionalparam>-Xdoclint:none</additionalparam>
    </properties>

Загальне рішення, подане тут в інших відповідях (додаючи, що властивість у розділі плагінів) чомусь не спрацювало. Тільки встановивши його в глобальному масштабі, я міг успішно створити баночку javadoc.

Найкоротше рішення, яке буде працювати з будь-якою версією Java:

<profiles>
    <profile>
        <id>disable-java8-doclint</id>
        <activation>
            <jdk>[1.8,)</jdk>
        </activation>
        <properties>
            <additionalparam>-Xdoclint:none</additionalparam>
        </properties>
    </profile>
</profiles>

Просто додайте це до своєї POM, і ви готові йти.

Це в основному відповідь @ ankon плюс відповідь @ zapp .

Для користувачів maven-javadoc-plugin 3.0.0:

Замініть

<additionalparam>-Xdoclint:none</additionalparam>

від

<doclint>none</doclint>

Я не думаю, що просто вимкнути DocLint - це хороше рішення, принаймні, не довгостроково. Добре, що Javadoc став трохи більш суворим, тому правильним способом виправити проблему збірки є виправлення основної проблеми . Так, вам потрібно буде виправити ці файли вихідного коду.

Ось, на що слід звернути увагу, на що раніше могли піти:

• Неправильний HTML-код (наприклад, відсутній кінцевий тег, необроблені дужки тощо)
• Недійсний {@link }s. (те саме стосується подібних тегів, таких як @see)
• Недійсні @authorзначення. Це було прийнято: @author John <john.doe@mine.com>але вже не так через дужки, що не вийшли.
• Таблиці HTML в Javadoc тепер вимагають підсумок або підписи. Дивіться це питання для пояснення.

Вам просто доведеться виправити файли вихідного коду і продовжувати створювати Javadoc, поки він не зможе побудувати без збоїв. Так громіздко, але особисто мені подобається, коли я довів свої проекти до рівня DocLint, тому що це означає, що я можу бути впевненішою, що Javadoc, який я виробляю, є власне тим, що я маю намір.

Звичайно, проблема є, якщо ви генеруєте Javadoc на якомусь вихідному коді, який ви не створили самостійно, наприклад, тому що він надходить з якогось генератора коду, наприклад, wsimport . Дивно, що Oracle не готував власні інструменти для відповідності JDK8, перш ніж випустити JDK8. Здається, він не буде виправлений до Java 9 . Тільки в цьому конкретному випадку я пропоную вимкнути DocLint, як це зафіксовано в інших місцях на цій сторінці.

maven-javadoc-pluginТільки конфігурація, що перекриває , не виправляє проблему mvn site(використовується, наприклад, на етапі випуску). Ось що я мав зробити:

<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>
      <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>-Xdoclint:none</additionalparam>
              </configuration>
            </plugin>
          </reportPlugins>
        </configuration>
      </plugin>
    </plugins>
  </build>
</profile>

Ви можете спробувати встановити failOnErrorвластивість (див. Документацію на плагіни ) на false:

<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>
              <failOnError>false</failOnError>
            </configuration>
        </execution>
    </executions>
</plugin>

Як видно з документів, значенням за замовчуванням є true.

Оскільки це залежить від версії вашого JRE, яка використовується для запуску команди maven, ви, мабуть, не хочете відключити DocLintза замовчуванням у своєму pom.xml

Отже, з командного рядка ви можете використовувати комутатор -Dadditionalparam=-Xdoclint:none.

Приклад: mvn clean install -Dadditionalparam=-Xdoclint:none

Ім'я властивості конфігурації було змінено в останній версії плагіна maven-javadoc, що становить 3.0.0.

Отже, <додатковий параметр> не буде працювати. Тож ми маємо його змінити, як показано нижче.

   <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>3.0.0</version>
      <configuration>
         <doclint>none</doclint>
      </configuration>
  </plugin>

Я хотів би додати трохи розуміння інших відповідей

У моєму випадку

-Xdoclint: немає

Не працювало.

Почнемо з того, що в моєму проекті мені взагалі не потрібен був явадок. Лише деякі необхідні плагіни мали залежність від часу побудови.

Отже, найпростіший спосіб вирішити мою проблему:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <skip>true</skip>
    </configuration>
</plugin>

За Maven-Javadoc-плагін 3.0.0 ви повинні були з допомогою additionalJOption встановити додаткову опцію Javadoc, так що якщо ви хочете , щоб відключити Javadoc doclint, необхідно додати наступне властивість.

<properties>
    ...
    <additionalJOption>-Xdoclint:none</additionalJOption>
    ...
<properties>

Також слід згадати версію maven-javadoc-плагіна як версію 3.0.0 або новішу.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.0</version>    
</plugin>

Отже, заощадите собі кілька годин, яких я не зробив, і спробуйте це, якщо здається, що це не працює:

 <additionalJOption>-Xdoclint:none</additionalJOption>

Тег змінено для новіших версій.

Додано нижче

JAVA_TOOL_OPTIONS=-DadditionalJOption=-Xdoclint:none

На роботу в Дженкінс:

Конфігурація> Навколишнє середовище> Введіть змінні середовища в процес збирання> Властивості Зміст

Вирішив мою проблему створення коду через Дженкінс Мейвен :-)

Я не впевнений, чи допоможе це, але я зовсім недавно зіткнувся з цією ж проблемою, що стосується версії oozie-4.2.0 . Після прочитання вищезазначених відповідей я тільки що додав параметр maven через командний рядок, і він працював на мене. Отже, просто поділитися тут.

Я використовую java 1.8.0_77 , не пробував з java 1.7

bin / mkdistro.sh -DskipTests -Dmaven.javadoc.opts = '- Xdoclint: -html'

Щоб ігнорувати відсутні @paramі @returnтеги, достатньо відключити missing групу doclint . Таким чином, javadoc все ще перевірятиметься на проблеми вищого рівня та синтаксису:

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.0.0</version>
        <configuration>
            <doclint>all,-missing</doclint>
        </configuration>
    </plugin>

Зверніть увагу, що це для плагіна версії 3.0 або новішої.

Я трохи запізнююся на вечірку, але мене теж змусили шукати обхід, опинився тут, а потім знайшов його.

Ось що для мене працює: -

export JAVA_TOOL_OPTIONS=-DadditionalJOption=-Xdoclint:none

А потім почніть збирання Maven, будь-яку збірку дистрибутивів Linux і т.д. Приємна річ у тому, що він не потребує модифікації файлів конфігурації Maven - я не міг цього робити, оскільки моя мета полягала в тому, щоб відновити купу пакетів Centos rpm, тому довелося зайти справді глибоко.