Da quando uso Maven sono stato in grado di creare e installare nei miei repository locali progetti con tag Javadoc incompleti (ad esempio un parametro mancante).

Tuttavia, da quando sono migrato a Java 8 (1.8.0-ea-b90) Maven è assolutamente severo riguardo alla mancanza di tag di documentazione e mi mostra molti errori Javadoc relativi a problemi Javadoc quando provo a costruire o installare un progetto in cui Javadoc non è "Perfetto". Alcuni dei progetti che sto cercando di compilare e installare nel mio repository locale sono progetti di terze parti da cui non ho il controllo. Quindi la soluzione alternativa del semplice aggiustare tutti i Javadocs in tutti questi progetti non sembra fattibile nel mio scenario.

Questa è una piccola parte dell'output che vedo quando eseguo mvn clean package installnel mio progetto:

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

Il plug-in Javadoc Maven è configurato in questo modo nel mio 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>

Come ho detto prima, tutto funziona bene se torno a Java 7. Forse è un bug relativo a Maven in esecuzione su Java 8? Come potrei farlo funzionare (ovvero, poter costruire il Javadoc del progetto e installarne il codice nel mio repository locale) con Java 8? Ho testato con Maven 3.0.3 e 3.0.5 in OSX.

AGGIORNARE:

Se cambio la configurazione del mio plug-in Javadoc con <failOnError>false</failOnError>(grazie 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>

Quindi il progetto viene installato nel mio repository locale. Tuttavia, il JAR Javadoc non viene ancora generato.

Un frammento dell'output che vedo nella console con questa nuova configurazione è:

[ERRORE] MavenReportException: errore durante la creazione dell'archivio: codice di uscita: 1 - /Users/....java:18: avviso: no @param ... La riga di comando era: / Library / Java / Home / bin / javadoc @options @pacchi

Fare riferimento ai file Javadoc generati nella directory '/ Users / sergioc / Documents / workspaces / heal / minitoolbox / target / apidocs'.

at org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeJavadocCommandLine (AbstractJavadocMojo.java:5043) at org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeReportjo0ache.Mav.99J.av .javadoc.JavadocJar.execute (JavadocJar.java:181) at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo (DefaultBuildPluginManager.java:101) at org.apache.maven.lifecjo.ecut.oec.External : 209) su org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:153) su org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:145) su org.apache. maven.lifecycle.internal.LifecycleModuleBuilder.buildProject (LifecycleModuleBuilder.java:84) su org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject (LifecycleModuleBuilder.java:59) su org.apache.maven.lifecycle.internal.LifecycleStarter.singleThreadedBuild (LifecycleStarter.java:183) su org.apache.maven.lifecycle.internal.LifecycleStarter.execycle) su org.apache.maven.DefaultMaven.doExecute (DefaultMaven.java:320) su org.apache.maven.DefaultMaven.execute (DefaultMaven.java:156) su org.apache.maven.cli.MavenCli.execute (MavenCli.java : 537) at org.apache.maven.cli.MavenCli.doMain (MavenCli.java:196) at org.apache.maven.cli.MavenCli.main (MavenCli.java:141) at sun.reflect.NativeMethodAccessorImpl.invoke0 ( Metodo nativo) at sun.reflect.NativeMethodAccessorImpl.invoke (NativeMethodAccessorImpl.java:57) at sun.reflect.DelegatingMethodAccessorImpl.invoke (DelegatingMethodAccessorImpl.java:43) at java.langetfl.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) su org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode (Launcher.java:409) su org.codehaus.plexus.classworlds.launcher.Launcher.main (Launcher.java:352)

Qualche soluzione alternativa su come costruire i sorgenti, installare il progetto e generare il JAR Javadoc in un solo passaggio mentre funzionava con Java 7?

La soluzione migliore sarebbe quella di correggere gli errori javadoc. Se per qualche motivo ciò non è possibile (ad es .: codice sorgente generato automaticamente), è possibile disabilitare questo controllo.

DocLint è una nuova funzionalità di Java 8 , che è riassunta in:

Fornire un mezzo per rilevare errori nei commenti Javadoc nelle prime fasi del ciclo di sviluppo e in modo che sia facilmente ricollegabile al codice sorgente.

Questo è abilitato per impostazione predefinita e eseguirà molti controlli prima di generare Javadocs. È necessario disattivarlo per Java 8 come specificato in questo thread . Dovrai aggiungere questo alla tua configurazione 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>

Per maven-javadoc-plugin 3.0.0+: Sostituisci

<additionalparam>-Xdoclint:none</additionalparam>

con

<doclint>none</doclint>

L'approccio più semplice per far funzionare le cose con java 8 e java 7 è usare un profilo nella build:

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

Ecco il modo più conciso di cui sono a conoscenza per ignorare gli avvisi di doclint indipendentemente dalla versione java utilizzata. Non è necessario duplicare la configurazione del plug-in in più profili con lievi modifiche.

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

Testato su Oracle / Open jdk 6, 7, 8 e 11.

Aggiungi nella sezione delle proprietà globali nel file pom:

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

La soluzione comune fornita qui nelle altre risposte (aggiungendo quella proprietà nella sezione plugin) non ha funzionato per qualche motivo. Solo impostandolo a livello globale ho potuto costruire con successo il vaso javadoc.

La soluzione più breve che funzionerà con qualsiasi versione di Java:

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

Aggiungilo al tuo POM e sei a posto.

Questa è sostanzialmente la risposta di @ ankon più la risposta di @ zapp .

Per gli utenti di maven-javadoc-plugin 3.0.0:

Sostituire

<additionalparam>-Xdoclint:none</additionalparam>

di

<doclint>none</doclint>

Non credo che disattivare DocLint sia una buona soluzione, almeno non a lungo termine. È positivo che Javadoc sia diventato un po 'più rigoroso, quindi il modo giusto per risolvere il problema di compilazione è quello di risolvere il problema sottostante . Sì, alla fine dovrai correggere quei file di codice sorgente.

Ecco le cose a cui prestare attenzione che in precedenza potresti cavartela:

• HTML non valido (ad esempio un tag di fine mancante, parentesi non di escape, ecc.)
• {@link }S non valido (lo stesso vale per tag simili come @see)
• @authorValori non validi Questo era accettato: @author John <john.doe@mine.com>ma non più per le parentesi non salvate.
• Le tabelle HTML in Javadoc ora richiedono un riepilogo o una didascalia. Vedi questa domanda per una spiegazione.

Dovrai semplicemente riparare i tuoi file di codice sorgente e continuare a creare il tuo Javadoc fino a quando non può essere compilato senza errori. Ingombrante sì, ma personalmente mi piace quando ho portato i miei progetti a livello di DocLint perché significa che posso essere più sicuro che il Javadoc che produco sia effettivamente quello che intendo.

C'è ovviamente il problema se stai generando Javadoc su un codice sorgente che non hai prodotto da te, ad esempio perché proviene da un generatore di codice, ad esempio wsimport . Strano che Oracle non abbia preparato i propri strumenti per la conformità JDK8 prima di rilasciare effettivamente JDK8. Sembra che non sarà risolto fino a Java 9 . Solo in questo caso particolare suggerisco di disattivare DocLint come documentato altrove in questa pagina.

Sostituendo maven-javadoc-pluginsolo la configurazione, non risolve il problema con mvn site(utilizzato ad es. Durante la fase di rilascio). Ecco cosa dovevo fare:

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

È possibile provare a impostare la failOnErrorproprietà (consultare la documentazione del plug-in ) su 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>

Come puoi vedere dai documenti, il valore predefinito è true.

Dal momento che dipende dalla versione di JRE che viene utilizzata per eseguire il comando maven che probabilmente non si desidera disabilitare DocLint per impostazione predefinita in pom.xml

Quindi, dalla riga di comando è possibile utilizzare l'opzione -Dadditionalparam=-Xdoclint:none .

Esempio: mvn clean install -Dadditionalparam=-Xdoclint:none

Il nome della proprietà di configurazione è stato modificato nell'ultima versione di maven-javadoc-plugin che è 3.0.0.

Quindi il <additionalparam> non funzionerà. Quindi dobbiamo modificarlo come di seguito.

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

Vorrei aggiungere alcune informazioni su altre risposte

Nel mio caso

-Xdoclint: nessuno

Non ha funzionato

Cominciamo con quello, nel mio progetto, non avevo davvero bisogno di javadoc. Solo alcuni plugin necessari avevano una dipendenza dal tempo di costruzione.

Quindi, il modo più semplice per risolvere il mio problema è stato:

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

A partire da maven-javadoc-plugin 3.0.0 avresti dovuto usare additionalJOption per impostare un'opzione Javadoc aggiuntiva, quindi se desideri che Javadoc disabiliti doclint, dovresti aggiungere la seguente proprietà.

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

Dovresti anche menzionare la versione di maven-javadoc-plugin come 3.0.0 o successiva.

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

Quindi, risparmiati qualche ora che non ho fatto e prova questo se sembra non funzionare:

 <additionalJOption>-Xdoclint:none</additionalJOption>

Il tag è cambiato per le versioni più recenti.

Aggiunto di seguito

JAVA_TOOL_OPTIONS=-DadditionalJOption=-Xdoclint:none

Nel lavoro di Jenkins:

Configurazione> Ambiente di compilazione> Inietti variabili di ambiente nel processo di generazione> Contenuto proprietà

Risolto il mio problema di creazione del codice tramite Jenkins Maven :-)

Non sono sicuro che questo possa aiutare, ma anche di recente ho affrontato lo stesso identico problema con la versione oozie-4.2.0 . Dopo aver letto le risposte sopra ho appena aggiunto l'opzione Maven tramite riga di comando e ha funzionato per me. Quindi, sto solo condividendo qui.

Sto usando Java 1.8.0_77 , non ho provato con Java 1.7

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

Per ignorare i tag mancanti @parame i @returntag, è sufficiente disabilitare il missing gruppo doclint . In questo modo, javadoc verrà comunque verificato per problemi di sintassi e di livello superiore:

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

Si noti che questo è per plugin versione 3.0 o successiva.

Sono un po 'in ritardo alla festa, ma sono stato costretto a cercare una soluzione alternativa, sono finito qui e poi l'ho trovato.

Ecco cosa funziona per me: -

export JAVA_TOOL_OPTIONS=-DadditionalJOption=-Xdoclint:none

E poi avvia la tua build Maven, qualsiasi build di distribuzione Linux ecc. La cosa bella è che non richiede la modifica dei file di configurazione di Maven - non potevo farlo poiché il mio obiettivo era quello di ricostruire un sacco di pacchetti rpm Centos , quindi ho dovuto andare davvero in profondità.