Odkąd korzystam z Maven, byłem w stanie zbudować i zainstalować w moim lokalnym repozytorium projekty, które mają niekompletne tagi Javadoc (na przykład brakujący parametr).

Ponieważ jednak przeprowadziłem migrację do Javy 8 (1.8.0-ea-b90), Maven jest absolutnie surowy w kwestii brakujących znaczników dokumentacji i pokazuje mi wiele błędów Javadoc związanych z problemami Javadoc, gdy próbuję zbudować lub zainstalować projekt, w którym Javadoc nie jest "idealny". Niektóre projekty, które próbuję skompilować i zainstalować w moim lokalnym repozytorium, to projekty stron trzecich, nad którymi nie mam kontroli. Zatem obejście po prostu naprawienia wszystkich Javadoców we wszystkich tych projektach nie wydaje się wykonalne w moim scenariuszu.

Oto niewielka część danych wyjściowych, które widzę podczas wykonywania mvn clean package installw moim projekcie:

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

Wtyczka Javadoc Maven jest skonfigurowana w następujący sposób w mojej 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>

Jak powiedziałem wcześniej, wszystko działa poprawnie, jeśli wrócę do Javy 7. Być może jest to błąd związany z działaniem Mavena w Javie 8? Jak mogę sprawić, by działało (tj. Móc zbudować Javadoc projektu i zainstalować jego kod w moim lokalnym repozytorium) z Javą 8? Testowałem zarówno z Maven 3.0.3, jak i 3.0.5 w OSX.

AKTUALIZACJA:

Jeśli zmienię konfigurację wtyczki Javadoc za pomocą <failOnError>false</failOnError>(dzięki Martin):

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

Następnie projekt jest instalowany w moim lokalnym repozytorium. Jednak JAR Javadoc nadal nie jest generowany.

Fragment danych wyjściowych, które widzę w konsoli w tej nowej konfiguracji, to:

[BŁĄD] MavenReportException: Błąd podczas tworzenia archiwum: Kod zakończenia: 1 - /Users/....java:18: ostrzeżenie: no @param ... Wiersz polecenia to: / Library / Java / Home / bin / javadoc @options @pakiety

Zapoznaj się z wygenerowanymi plikami Javadoc w katalogu „/ Users / sergioc / Documents / workspaces / heal / minitoolbox / target / apidocs”.

w org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeJavadocCommandLine (AbstractJavadocMojo.java:5043) w org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeReport (AbstractJavadocMo990) .javadoc.JavadocJar.execute (JavadocJar.java:181) w org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo (DefaultBuildPluginManager.java:101) w org.apache.maven.lifecycle.internal.MojoExecja : 209) w org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:153) w org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:145) w org.apache. maven.lifecycle.internal.LifecycleModuleBuilder.buildProject (LifecycleModuleBuilder.java:84) w org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject (LifecycleModuleBuilder.java:59) w org.apache.maven.lifecycle.internal.LifecycleStarter.singleThreadedBuild (LifecycleStarter.java:183) w org.apache.maven.lifecycle.internal.LifecycleStarter.execute (Lifecycle16arter.ja) w org.apache.maven.DefaultMaven.doExecute (DefaultMaven.java:320) w org.apache.maven.DefaultMaven.execute (DefaultMaven.java:156) w org.apache.maven.cli.MavenCli.execute (MavenCli.java : 537) w org.apache.maven.cli.MavenCli.doMain (MavenCli.java:196) w org.apache.maven.cli.MavenCli.main (MavenCli.java:141) w sun.reflect.NativeMethodAccessorImpl.invoke0 ( Metoda rodzima) w sun.reflect.NativeMethodAccessorImpl.invoke (NativeMethodAccessorImpl.java:57) w sun.reflect.DelegatingMethodAccessorImpl.invoke (DelegatingMethodAccessorImpl.java:43) w java.lang.reflect.Method.wywołaj (Method.java:491) w org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced (Launcher.java:290) w org.codehaus.plexus.classworlds.launcher.Launcher.launch (Launcher.java:230) w org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode (Launcher.java:409) w org.codehaus.plexus.classworlds.launcher.Launcher.main (Launcher.java:352)

Jakieś obejście dotyczące sposobu budowania źródeł, instalowania projektu i generowania pliku JAR Javadoc w jednym kroku podczas pracy z Javą 7?

Najlepszym rozwiązaniem byłoby naprawić błędy javadoc. Jeśli z jakiegoś powodu nie jest to możliwe (np. Automatycznie wygenerowany kod źródłowy), możesz wyłączyć tę kontrolę.

DocLint to nowa funkcja w Javie 8 , którą podsumowano jako:

Zapewniają środki do wykrywania błędów w komentarzach Javadoc na wczesnym etapie cyklu programowania oraz w sposób, który można łatwo połączyć z powrotem z kodem źródłowym.

Jest to domyślnie włączone i przed wygenerowaniem Javadocs przeprowadzi wiele kontroli. Musisz wyłączyć to dla Java 8, jak określono w tym wątku . Musisz dodać to do swojej konfiguracji 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>

Dla maven-javadoc-plugin 3.0.0+: Zamień

<additionalparam>-Xdoclint:none</additionalparam>

z

<doclint>none</doclint>

Najłatwiejszym podejściem do pracy zarówno z java 8, jak i java 7 jest użycie profilu w kompilacji:

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

Oto najbardziej zwięzły sposób, w jaki jestem świadom ignorowania ostrzeżeń doclint niezależnie od używanej wersji Java. Nie ma potrzeby duplikowania konfiguracji wtyczek w wielu profilach z niewielkimi modyfikacjami.

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

Testowane na oracle / open jdk 6, 7, 8 i 11.

Dodaj do sekcji właściwości globalnych w pliku pom:

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

Wspólne rozwiązanie podane tutaj w innych odpowiedziach (dodanie tej właściwości w sekcji wtyczek) z jakiegoś powodu nie działało. Tylko ustawiając go globalnie, mogłem pomyślnie zbudować słoik javadoc.

Najkrótsze rozwiązanie, które będzie działać z dowolną wersją Java:

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

Po prostu dodaj to do POM i możesz zacząć.

Jest to w zasadzie odpowiedź @ ankon plus odpowiedź @ zapp .

Dla użytkowników maven-javadoc-plugin 3.0.0:

Zastąpić

<additionalparam>-Xdoclint:none</additionalparam>

przez

<doclint>none</doclint>

Nie sądzę, aby wyłączenie DocLint było dobrym rozwiązaniem, przynajmniej na dłuższą metę. Dobrze, że Javadoc stał się nieco bardziej rygorystyczny, więc właściwym sposobem rozwiązania problemu z kompilacją jest naprawienie podstawowego problemu . Tak, ostatecznie musisz naprawić te pliki kodu źródłowego.

Oto rzeczy, na które warto zwrócić uwagę:

• Zniekształcony HTML (na przykład brakujący znacznik końcowy, nawiasy nieoznaczone itp.)
• Nieprawidłowy {@link }s. (to samo dotyczy podobnych tagów, takich jak @see)
• Nieprawidłowe @authorwartości Kiedyś było to akceptowane: @author John <[email protected]>ale już nie tak z powodu nieuchwytnych nawiasów.
• Tabele HTML w Javadoc wymagają teraz streszczenia lub podpisu. Zobacz to pytanie w celu wyjaśnienia.

Musisz po prostu naprawić pliki kodu źródłowego i kontynuować tworzenie Javadoc, dopóki nie będzie można go skompilować bez awarii. Uciążliwe tak, ale osobiście podoba mi się, kiedy podniosłem moje projekty do poziomu DocLint, ponieważ oznacza to, że mogę być bardziej pewny, że Javadoc, który produkuję, jest tym, co zamierzam.

Oczywiście istnieje problem, jeśli generujesz Javadoc na jakimś kodzie źródłowym, którego sam nie stworzyłeś, na przykład ponieważ pochodzi on z jakiegoś generatora kodu, np . Wsimport . Dziwne, że Oracle nie przygotowało własnych narzędzi do zgodności z JDK8 przed faktycznym wydaniem JDK8. Wygląda na to, że nie zostanie naprawiony, dopóki Java 9 . Tylko w tym konkretnym przypadku sugeruję wyłączenie DocLint zgodnie z dokumentacją w innym miejscu na tej stronie.

Zastępowanie maven-javadoc-plugintylko konfiguracji, nie rozwiązuje problemu mvn site(używane np. Na etapie wydania). Oto, co musiałem zrobić:

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

Możesz spróbować ustawić failOnErrorwłaściwość (patrz dokumentacja wtyczki ) na 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>

Jak widać z dokumentów, wartością domyślną jest true.

Ponieważ zależy to od wersji środowiska JRE używanego do uruchamiania polecenia maven, którego prawdopodobnie nie chcesz wyłączać DocLint domyślnie w pliku pom.xml

Dlatego z wiersza poleceń możesz użyć przełącznika -Dadditionalparam=-Xdoclint:none .

Przykład: mvn clean install -Dadditionalparam=-Xdoclint:none

Nazwa właściwości konfiguracji została zmieniona w najnowszej wersji wtyczki maven-javadoc, czyli 3.0.0.

Dlatego <additionalparam> nie będzie działać. Więc musimy to zmodyfikować jak poniżej.

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

Chciałbym dodać wgląd w inne odpowiedzi

W moim przypadku

-Xdoclint: brak

Nie działało

Zacznijmy od tego, że w moim projekcie tak naprawdę wcale nie potrzebowałem javadoc. Tylko niektóre niezbędne wtyczki zależały od czasu kompilacji.

Najprostszym sposobem rozwiązania mojego problemu było:

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

Począwszy od maven-javadoc-plugin 3.0.0, powinieneś był używać dodatkowej opcji JOption, aby ustawić dodatkową opcję Javadoc, więc jeśli chcesz, aby Javadoc wyłączał doclint, powinieneś dodać następującą właściwość.

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

Należy również wspomnieć o wersji wtyczki maven-javadoc jako 3.0.0 lub nowszej.

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

Więc zaoszczędź sobie kilka godzin, których nie zrobiłem i wypróbuj to, jeśli wydaje się, że nie działa:

 <additionalJOption>-Xdoclint:none</additionalJOption>

Tag został zmieniony dla nowszych wersji.

Dodano poniżej

JAVA_TOOL_OPTIONS=-DadditionalJOption=-Xdoclint:none

Do pracy Jenkinsa:

Konfiguracja> Środowisko kompilacji> Wprowadzaj zmienne środowiskowe do procesu budowania> Zawartość Właściwości

Rozwiązałem mój problem z budowaniem kodu przez Jenkins Maven :-)

Nie jestem pewien, czy to pomoże, ale nawet ostatnio miałem dokładnie taki sam problem z wersją oozie-4.2.0 . Po przeczytaniu powyższych odpowiedzi właśnie dodałem opcję maven za pomocą wiersza poleceń i zadziałało to dla mnie. Udostępniam tutaj.

Używam java 1.8.0_77 , nie próbowałem z java 1.7

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

Aby zignorować brakujące @parami @returnznaczniki, wystarczy wyłączyć missing grupę dokumentów . W ten sposób javadoc będzie nadal sprawdzany pod kątem problemów z wyższym poziomem i składnią:

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

Pamiętaj, że dotyczy to wtyczki w wersji 3.0 lub nowszej.

Jestem trochę spóźniony na przyjęcie, ale musiałem też szukać obejścia, znalazłem się tutaj, a potem go znalazłem.

Oto, co działa dla mnie: -

export JAVA_TOOL_OPTIONS=-DadditionalJOption=-Xdoclint:none

A potem rozpocznij kompilację Maven, dowolną kompilację dystrybucji Linuksa itp. Fajną rzeczą jest to, że nie wymaga modyfikacji plików konfiguracyjnych Maven - nie mogłem tego zrobić, ponieważ moim celem było przebudowanie wielu pakietów rpm Centos , więc musiałem idź naprawdę głęboko.