maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Thorsten Glaser (JIRA)" <>
Subject [jira] [Commented] (MJAVADOC-523) Exclude non-Java JARs from Maven Javadoc plugin processing
Date Tue, 27 Nov 2018 17:20:00 GMT


Thorsten Glaser commented on MJAVADOC-523:

Thanks for the workaround, it at least gets rid of several yellow and red lines in my Jenkins
output, making it more manageable. I’d still prefer a proper fix of course, and I don’t
know how this can negatively affect documentation.

Perhaps an invocation to build a dummy javadoc could be added to the non-Java modules, if
the plugin supports such… it’s easy enough to run it after all. Even better would be if
it could do that automatically, if invoked in a project without Java files, *and* skip attaching
the dummy javadoc, use it only to satisfy resolution.

> Exclude non-Java JARs from Maven Javadoc plugin processing
> ----------------------------------------------------------
>                 Key: MJAVADOC-523
>                 URL:
>             Project: Maven Javadoc Plugin
>          Issue Type: Bug
>          Components: javadoc
>    Affects Versions: 2.8
>            Reporter: Thorsten Glaser
>            Priority: Minor
> I have a multi-module project which builds a couple of JARs and then distributed them
into two WARs.
> However, one of the JARs does not contain any Java code at all, merely (maven-filtered)
resources. This leads to warnings during the build like these:
> {{[…]
> [INFO] --- maven-javadoc-plugin:2.8:jar (attach-javadocs) @ foo-services ---
> [INFO] The goal 'org.apache.maven.plugins:maven-javadoc-plugin:2.8:javadoc' has not been
previously called for the module: ''. Trying to
invoke it...
> [WARNING] Creating fake javadoc directory to prevent repeated invocations: /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs
> [ERROR] Error fetching link: /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs/package-list.
Ignored it.
> [INFO] 
> Loading source files for package
> […]}}
> I found how I can exclude javadoc stuff by package, but not by artifact.
> The plugin is currently included ONLY in the parent POM, like this:
> {{<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-javadoc-plugin</artifactId><version>2.8</version><executions><execution><id>attach-javadocs</id><goals><goal>jar</goal></goals></execution></executions></plugin>}}
> While it _is_ run during “compilation” of the resources-only JAR, it (obviously)
produces no result, thus the warning (as it’s not excluded either).
> How can I either make it produce something (i.e. the ability to create a valid-looking
yet contentless FOO-javadoc.jar that satisfies references by reverse dependencies, in a JAR
not containing any Java™ code) or, probably preferably, exclude the {{foo-rsrcs}} module
from being accessed by mjavadoc on modules depending on it?

This message was sent by Atlassian JIRA

View raw message