maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Falko Modler (Jira)" <j...@apache.org>
Subject [jira] [Comment Edited] (MJAVADOC-602) "Aggregating Javadocs For Multi-Projects" code snippet is garbled and <build/> tag example is missing
Date Mon, 02 Sep 2019 09:21:00 GMT

    [ https://issues.apache.org/jira/browse/MJAVADOC-602?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16920464#comment-16920464
] 

Falko Modler edited comment on MJAVADOC-602 at 9/2/19 9:20 AM:
---------------------------------------------------------------

[~rfscholte]: It is {{mvn validate -Pbuild-delivery-javadoc}}.
{code:xml|title=Full profile}
        <profile>
            <id>build-delivery-javadoc</id>
            <properties>
                <javadoc.archive>${basedir}/someproject/portal/delivery/target/portal-delivery-${revision}-javadoc.zip</javadoc.archive>
                <enforcer.skip>true</enforcer.skip>
            </properties>
            <build>
                <defaultGoal>validate</defaultGoal>
                <plugins>
                    <plugin>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <configuration>
                            <skip>true</skip>
                        </configuration>
                        <executions>
                            <execution>
                                <id>aggregate-javadoc</id>
                                <goals>
                                    <goal>aggregate-no-fork</goal>
                                </goals>
                                <phase>validate</phase>
                                <inherited>false</inherited>
                                <configuration>
                                    <skip>false</skip>
                                    <additionalOptions>
                                        <option>-Xdoclint:none</option>
                                    </additionalOptions>
                                    <author>false</author>
                                    <show>private</show>
                                    <quiet>true</quiet>
                                    <excludePackageNames>...</excludePackageNames>
                                </configuration>
                            </execution>
                        </executions>
                    </plugin>
                    <plugin>
                        <artifactId>maven-antrun-plugin</artifactId>
                        <executions>
                            <execution>
                                <id>build-javadoc-zip</id>
                                <goals>
                                    <goal>run</goal>
                                </goals>
                                <phase>validate</phase>
                                <inherited>false</inherited>
                                <configuration>
                                    <target>
                                        <zip destfile="${javadoc.archive}" basedir="${project.build.directory}/site/apidocs/"
/>
                                    </target>
                                </configuration>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
{code}


was (Author: famod):
[~rfscholte]: It is {{mvn validate -build-delivery-javadoc}}.
{code:xml|title=Full profile}
        <profile>
            <id>build-delivery-javadoc</id>
            <properties>
                <javadoc.archive>${basedir}/someproject/portal/delivery/target/portal-delivery-${revision}-javadoc.zip</javadoc.archive>
                <enforcer.skip>true</enforcer.skip>
            </properties>
            <build>
                <defaultGoal>validate</defaultGoal>
                <plugins>
                    <plugin>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <configuration>
                            <skip>true</skip>
                        </configuration>
                        <executions>
                            <execution>
                                <id>aggregate-javadoc</id>
                                <goals>
                                    <goal>aggregate-no-fork</goal>
                                </goals>
                                <phase>validate</phase>
                                <inherited>false</inherited>
                                <configuration>
                                    <skip>false</skip>
                                    <additionalOptions>
                                        <option>-Xdoclint:none</option>
                                    </additionalOptions>
                                    <author>false</author>
                                    <show>private</show>
                                    <quiet>true</quiet>
                                    <excludePackageNames>...</excludePackageNames>
                                </configuration>
                            </execution>
                        </executions>
                    </plugin>
                    <plugin>
                        <artifactId>maven-antrun-plugin</artifactId>
                        <executions>
                            <execution>
                                <id>build-javadoc-zip</id>
                                <goals>
                                    <goal>run</goal>
                                </goals>
                                <phase>validate</phase>
                                <inherited>false</inherited>
                                <configuration>
                                    <target>
                                        <zip destfile="${javadoc.archive}" basedir="${project.build.directory}/site/apidocs/"
/>
                                    </target>
                                </configuration>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
{code}

> "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
(v8.3.2#803003)

Mime
View raw message