2010-08-04 15 views
6

Questo è il mio file principale pom.xml (parte di esso) in un progetto multi-modulo:Come utilizzare javadoc: aggregato correttamente nel progetto Maven multi-modulo?

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

Questo plugin è ereditata in tutti i sotto-moduli e non credo che sia un approccio corretto. Quando sono in esecuzione mvn javadoc:aggregate la documentazione è generata in target/site/apidoc, ma il registro è pieno di avvertimenti:

... 
[WARNING] Removing: aggregate from forked lifecycle, 
to prevent recursive invocation. 
... 

Che cosa sto facendo di sbagliato?

risposta

10

È necessario abilitare i aggregazione per questo plugin:

<plugin> 
    <artifactId>maven-javadoc-plugin</artifactId> 
    <configuration> 
     <aggregate>true</aggregate> <!-- this enables aggretation --> 
    </configuration> 
    </plugin> 

Sul tipo di comando:

mvn javadoc:aggregate 

Edit:

Va bene, ho fatto un po 'scavare nel jira del plugin Maven e trovato che tutti i mojos del plugin javadoc sono stati annotati con @aggregator. Ma sembra che ci siano problemi con aggregatore di Maven la questione per la quale è stato depositato here bug

ci sono anche in relazione here e here e ancora un po '

Questo sembra essere un problema bloccante con aggregatore di Maven dal momento che alcuni plugin come per esempio il trifoglio non funzionerà.

Per per riassumere, si sta facendo nulla di male

Basta tornare alle versioni precedenti di Maven-javadoc-plugin che non utilizza @aggregator mojo annotazione e non sarà possibile ottenere gli avvertimenti (se non si è utilizzando alcune funzionalità del plugin javadoc che non è disponibile nella versione precedente)

In una nota a margine, se si esegue il plugin javadoc come report, @regregator viene ignorato.

+3

parametro di configurazione 'aggregate' è deprecato: http://maven.apache.org/plugins/maven-javadoc-plugin/aggregate-mojo.html#aggregate – yegor256

+0

@FaZend non hai specificato la versione del plug-in javadoc così come versione di prova. È deprecato nella versione 2.5. Ad ogni modo non ero a conoscenza di questo fatto – naikus

+0

@ FaZend.com, ho aggiornato la mia risposta con ulteriori dettagli – naikus

Problemi correlati