You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Falko Modler (JIRA)" <ji...@apache.org> on 2019/04/26 11:36:00 UTC
[jira] [Updated] (MJAVADOC-602) "Aggregating Javadocs For
Multi-Projects" code snippet is garbled and tag example is missing
[ https://issues.apache.org/jira/browse/MJAVADOC-602?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Falko Modler updated MJAVADOC-602:
----------------------------------
Description:
After MJAVADOC-134, I was trying to find out how to migrate my working 2.10.4 aggregation setup to 3.1.0.
It seems [the respective documentation|https://maven.apache.org/plugins/maven-javadoc-plugin/examples/aggregate.html] was extended with the info of [this JIRA comment|https://issues.apache.org/jira/browse/MJAVADOC-134?focusedCommentId=16724514&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-16724514], but something went wrong with the formatting:
!javadoc-aggregation-doc-formatting.PNG!
The other issue is that this bit doesn't cover the {{<build/>}} tag approach so I was fiddling around with this and ended up with:
{code:xml}
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
<executions>
<execution>
<id>aggregate-javadoc</id>
<goals>
<goal>aggregate-no-fork</goal>
</goals>
<inherited>false</inherited>
<configuration>
<skip>false</skip>
<!- ... -->
</configuration>
</execution>
</executions>
</plugin>
<!- ... -->
{code}
Notes: {{mvn -N ...}} does not work, but I don't want a separate aggregation for each module. So I skip the plugin in general/for all modules by _not_ inheriting {{<skip>false</skip>}}.
This (or some better solution) should be added to the docs.
PS: A flag/property to just skip the individual aggregations per module would be very much appreciated!
was:
After MJAVADOC-134, I was trying to find out how to migrate my working 2.10.4 aggregation setup to 3.1.0.
It seems [the respective documentation|https://maven.apache.org/plugins/maven-javadoc-plugin/examples/aggregate.html] was extended with the info of [this JIRA comment|https://issues.apache.org/jira/browse/MJAVADOC-134?focusedCommentId=16724514&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-16724514], but something went wrong with the formatting:
TODO
The other issue is that this bit doesn't cover the {{<build/>}} tag approach so I was fiddling around with this and ended up with:
{code:xml}
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
<executions>
<execution>
<id>aggregate-javadoc</id>
<goals>
<goal>aggregate-no-fork</goal>
</goals>
<inherited>false</inherited>
<configuration>
<skip>false</skip>
<!- ... -->
</configuration>
</execution>
</executions>
</plugin>
<!- ... -->
{code}
Notes: {{mvn -N ...}} does not work, but I don't want a separate aggregation for each module. So I skip the plugin in general/for all modules by _not_ inheriting {{<skip>false</skip>}}.
This (or some better solution) should be added to the docs.
PS: A flag/property to just skip the individual aggregations per module would be very much appreciated!
> "Aggregating Javadocs For Multi-Projects" code snippet is garbled and <build/> tag example is missing
> -----------------------------------------------------------------------------------------------------
>
> Key: MJAVADOC-602
> URL: https://issues.apache.org/jira/browse/MJAVADOC-602
> Project: Maven Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 3.1.0
> Reporter: Falko Modler
> Priority: Major
> Attachments: javadoc-aggregation-doc-formatting.PNG
>
>
> After MJAVADOC-134, I was trying to find out how to migrate my working 2.10.4 aggregation setup to 3.1.0.
> It seems [the respective documentation|https://maven.apache.org/plugins/maven-javadoc-plugin/examples/aggregate.html] was extended with the info of [this JIRA comment|https://issues.apache.org/jira/browse/MJAVADOC-134?focusedCommentId=16724514&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-16724514], but something went wrong with the formatting:
> !javadoc-aggregation-doc-formatting.PNG!
> The other issue is that this bit doesn't cover the {{<build/>}} tag approach so I was fiddling around with this and ended up with:
> {code:xml}
> <build>
> <plugins>
> <plugin>
> <groupId>org.apache.maven.plugins</groupId>
> <artifactId>maven-javadoc-plugin</artifactId>
> <configuration>
> <skip>true</skip>
> </configuration>
> <executions>
> <execution>
> <id>aggregate-javadoc</id>
> <goals>
> <goal>aggregate-no-fork</goal>
> </goals>
> <inherited>false</inherited>
> <configuration>
> <skip>false</skip>
> <!- ... -->
> </configuration>
> </execution>
> </executions>
> </plugin>
> <!- ... -->
> {code}
> Notes: {{mvn -N ...}} does not work, but I don't want a separate aggregation for each module. So I skip the plugin in general/for all modules by _not_ inheriting {{<skip>false</skip>}}.
> This (or some better solution) should be added to the docs.
> PS: A flag/property to just skip the individual aggregations per module would be very much appreciated!
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)