[
https://issues.apache.org/jira/browse/MJAVADOC-640?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17958025#comment-17958025
]
Olivier Lamy commented on MJAVADOC-640:
---------------------------------------
This project has moved from Jira to GitHub Issues. This issue was migrated to
[apache/maven-javadoc-plugin#945|https://github.com/apache/maven-javadoc-plugin/issues/945].
> Ability to exclude maven modules from javadoc aggregate goals
> -------------------------------------------------------------
>
> Key: MJAVADOC-640
> URL: https://issues.apache.org/jira/browse/MJAVADOC-640
> Project: Maven Javadoc Plugin (Moved to GitHub Issues)
> Issue Type: Improvement
> Affects Versions: 3.1.1
> Environment: Java 11
> Reporter: Joe DiPol
> Assignee: Olivier Lamy
> Priority: Major
> Fix For: 3.2.0
>
>
> This is a request to add a configuration option to provide a list of maven
> modules to exclude from javadoc aggregate goals. For example:
> {code:java}
> <excludeSubModules>internal,test,util</excludeSubModules>
> {code}
> When a javadoc aggregate goal is run the modules listed are skipped/ignored.
> *Motivation*
> We have a fairly complicated multi-module Maven project. We generate Java 11
> javadoc - therefore Java modules enter the picture. The artifacts we deploy
> are all named Java modules - so far, so good. But we also have Maven modules
> that we don't deploy. And we don't want aggregated javadoc for them. And
> they really aren't Java modules. We want them to be ignored by the aggregate
> Javadoc goal. But they are part of our default reactor because we need those
> modules to build/test our project. It's not practical to shape the reactor
> just for the sake of the aggregated javadoc.
> The aggregate goal also requires that all modules in the reactor be named:
> {code:java}
> getLog().error( "Creating an aggregated report for both named and unnamed
> modules is not possible." );
> {code}
> One work-around for this is to add an Automatic-Module-Name to the unnamed
> modules. Unfortunately that only works if the javadoc goal is run as part of
> a build life cycle (so that there are attached artifacts with the manifest).
> During development, nobody wants to build the full project just to generate
> aggregated javadoc.
> So that means we have to add a module-info file for all of our Maven modules,
> even if they really are not Java modules. Even if we don't want the
> aggregated javadoc to include them. For our project this has turned into a
> significant hassle.
> If we had an option to tell the aggregate goal to skip some submodules then
> this problem goes away, and it becomes much easier for us to build and
> maintain the aggregated javadoc.
>
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
