2010-08-04 17 views
6

Este es mi archivo principal pom.xml (parte de ella) en un proyecto de varios módulos:Cómo usar javadoc: ¿se agrega correctamente en el proyecto maven de varios módulos?

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

Este plugin se hereda en todos los sub-módulos y no creo que es un enfoque correcto. Cuando estoy corriendo mvn javadoc:aggregate la documentación se genera en target/site/apidoc, pero el registro está lleno de advertencias:

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

¿Qué estoy haciendo mal?

Respuesta

10

necesita habilitar la agregación de este plugin:

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

En el tipo de línea de comandos:

mvn javadoc:aggregate 

Editar:

bien, hice un poco de excavación en jira experto del plugin y encontrado que todos los mojos de los complementos de javadoc se han anotado con @aggregator. Pero parece que hay problemas con el agregador de experto en el tema para el que se ha presentado here errores

Hay también están relacionados here y here y algunos más

Esto parece ser un tema bloqueador con agregador de experto, ya que algunos plugins como p.ej el trébol no se ejecutará.

Para En resumen, que está haciendo nada malo

Sólo volver a versiones anteriores de maven-javadoc-plugin que no utiliza @aggregator anotación mojo y no conseguirá las advertencias (a menos que esté uso de cierta característica del complemento javadoc que no está disponible en la versión anterior)

En una nota lateral, si ejecuta el complemento javadoc como informe, entonces se ignora @aggregator.

+3

parámetro de configuración 'aggregate' está en desuso: http://maven.apache.org/plugins/maven-javadoc-plugin/aggregate-mojo.html#aggregate – yegor256

+0

@FaZend no ha especificado la versión del complemento de javadoc, así como versión de maven. Está en desuso en la versión 2.5. De todos modos no estaba al tanto de este hecho – naikus

+0

@ FaZend.com, he actualizado mi respuesta con detalles adicionales – naikus

Cuestiones relacionadas