Need help: maven-javadoc-plugin: includeDependencySource: error: module not found on module source path

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Need help: maven-javadoc-plugin: includeDependencySource: error: module not found on module source path

Tim Neumann
Hello everybody,

I'm struggling to get javadoc generation with includeDependencySource
working in my project.

When setting includeDependencySource to true in the pom and running mvn
clean install javadoc:aggregate or mvn clean install javadoc:javadoc

I get the following errors:

First: [ERROR] no reactor project: <group_id:artifact_id of the single
dependency of my project>

And a few lines later a BUILD FAILURE because the javadoc tool exited
with the following error:
Exit code: 1 -
/path/to/my/project/target/distro-javadoc-sources/<Dependency_Project_Artifact_Id>-<Version>-sources/module-info.java:10:
error: module not found on module source path

But the source of the dependency seems to be fetched and unpacked
correctly to
/path/to/my/project/target/distro-javadoc-sources/<Dependency_Project_Artifact_Id>-<Version>-sources/
The line (10) where the error is is the module definition of the single
in that project.

The generated javdoc options file contains only one module-source-path:
/path/to/my/project/target/site/apidocs/src which contains a single
empty folder named like the module of my project (not the dependency).

Did anyone have a similar problem before? Any ideas what to try?

If anyone wants to look at the whole pom or try to reproduce it, the
project is on github: https://github.com/fius/jvk in the folder project.
The only dependency of that project is also on github:
https://github.com/FIUS/ICGE2
For trying to get this to work I made some changes to both, which are
not merged yet. See these pull-requests:
https://github.com/FIUS/ICGE2/pull/186 and
https://github.com/FIUS/jvk/pull/71
For this testing I'm using version 2.3.5-Snapshot of the dependency and
just locally running mvn clean install in it instead of uploading it to
a maven repository.

Regards,
Tim

--
Tim Neumann (GPG-Key: B5BD 17C3 BD4A 7BA4)      
stv. Referent für IT Betreung
Studierendenvertretung Uni Stuttgart
https://stuvus.uni-stuttgart.de



---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: Need help: maven-javadoc-plugin: includeDependencySource: error: module not found on module source path

Benjamin Marwell-2
Hi Tim,

this lines makes me wonder:

> [ERROR] no reactor project: <group_id:artifact_id of the single dependency of my project>

I think this means that <includeDependencySources> will only work with
dependencies from the same reactor project. Thus your
"group_id:artifact_id of the single dependency of my project" seems to
be a foreign project?

But then from the goal description [1] it does not mention "must be on
the same reactor project".
Do you see a message that "group_id:artifact_id:source:jar could not
be fetched" or similar?


[1] https://maven.apache.org/plugins/maven-javadoc-plugin/aggregate-mojo.html

Am Sa., 17. Okt. 2020 um 18:08 Uhr schrieb Tim Neumann
<[hidden email]>:

>
> Hello everybody,
>
> I'm struggling to get javadoc generation with includeDependencySource
> working in my project.
>
> When setting includeDependencySource to true in the pom and running mvn
> clean install javadoc:aggregate or mvn clean install javadoc:javadoc
>
> I get the following errors:
>
> First: [ERROR] no reactor project: <group_id:artifact_id of the single
> dependency of my project>
>
> And a few lines later a BUILD FAILURE because the javadoc tool exited
> with the following error:
> Exit code: 1 -
> /path/to/my/project/target/distro-javadoc-sources/<Dependency_Project_Artifact_Id>-<Version>-sources/module-info.java:10:
> error: module not found on module source path
>
> But the source of the dependency seems to be fetched and unpacked
> correctly to
> /path/to/my/project/target/distro-javadoc-sources/<Dependency_Project_Artifact_Id>-<Version>-sources/
> The line (10) where the error is is the module definition of the single
> in that project.
>
> The generated javdoc options file contains only one module-source-path:
> /path/to/my/project/target/site/apidocs/src which contains a single
> empty folder named like the module of my project (not the dependency).
>
> Did anyone have a similar problem before? Any ideas what to try?
>
> If anyone wants to look at the whole pom or try to reproduce it, the
> project is on github: https://github.com/fius/jvk in the folder project.
> The only dependency of that project is also on github:
> https://github.com/FIUS/ICGE2
> For trying to get this to work I made some changes to both, which are
> not merged yet. See these pull-requests:
> https://github.com/FIUS/ICGE2/pull/186 and
> https://github.com/FIUS/jvk/pull/71
> For this testing I'm using version 2.3.5-Snapshot of the dependency and
> just locally running mvn clean install in it instead of uploading it to
> a maven repository.
>
> Regards,
> Tim
>
> --
> Tim Neumann (GPG-Key: B5BD 17C3 BD4A 7BA4)
> stv. Referent für IT Betreung
> Studierendenvertretung Uni Stuttgart
> https://stuvus.uni-stuttgart.de
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [hidden email]
> For additional commands, e-mail: [hidden email]
>

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: Need help: maven-javadoc-plugin: includeDependencySource: error: module not found on module source path

Benjamin Marwell-2
Hi Thomas,

I investigated a bit further. It seems from the debug output, that the
remote sources were fetched.  Thus, the error seems misleading:

[DEBUG] Expanding:
$USER/.m2/repository/de/uni-stuttgart/informatik/fius/ICGE-Simulation/2.3.6/ICGE-Simulation-2.3.6-sources.jar
into $USER/git/apache/jvk/project/target/distro-javadoc-sources/ICGE-Simulation-2.3.6-sources
[DEBUG] Trying to add links for modules...
[ERROR] no reactor project: de.uni-stuttgart.informatik.fius:ICGE-Simulation


So I tried to add this path manually like this:

                        <plugin>
                                <groupId>org.apache.maven.plugins</groupId>
                                <artifactId>maven-javadoc-plugin</artifactId>
-                               <version>3.1.1</version>
+                               <version>3.2.0</version>
                                <configuration>

<additionalOptions>--show-packages=all</additionalOptions>

<excludePackageNames>de.unistuttgart.informatik.fius.jvk.tasks:de.unistuttgart.informatik.fius.jvk.verifier</excludePackageNames>
+
<includeDependencySources>true</includeDependencySources>

<detectJavaApiLink>true</detectJavaApiLink>
                                        <links>

<link>https://fius.github.io/ICGE2/${icge.version}</link>
                                        </links>
+
<sourcepath>${sourcepath}:target/distro-javadoc-sources/ICGE-Simulation-2.3.6-sources</sourcepath>
                                </configuration>
                        </plugin>
                        <plugin>

And:
BUILD SUCCESS

So I think you found a bug where module sources are not being added to
the javadoc source path AND there is a misleading error message.
Would you kindly open two issues?

Am Mi., 28. Okt. 2020 um 20:18 Uhr schrieb Benjamin Marwell
<[hidden email]>:

>
> Hi Tim,
>
> this lines makes me wonder:
>
> > [ERROR] no reactor project: <group_id:artifact_id of the single dependency of my project>
>
> I think this means that <includeDependencySources> will only work with
> dependencies from the same reactor project. Thus your
> "group_id:artifact_id of the single dependency of my project" seems to
> be a foreign project?
>
> But then from the goal description [1] it does not mention "must be on
> the same reactor project".
> Do you see a message that "group_id:artifact_id:source:jar could not
> be fetched" or similar?
>
>
> [1] https://maven.apache.org/plugins/maven-javadoc-plugin/aggregate-mojo.html
>
> Am Sa., 17. Okt. 2020 um 18:08 Uhr schrieb Tim Neumann
> <[hidden email]>:
> >
> > Hello everybody,
> >
> > I'm struggling to get javadoc generation with includeDependencySource
> > working in my project.
> >
> > When setting includeDependencySource to true in the pom and running mvn
> > clean install javadoc:aggregate or mvn clean install javadoc:javadoc
> >
> > I get the following errors:
> >
> > First: [ERROR] no reactor project: <group_id:artifact_id of the single
> > dependency of my project>
> >
> > And a few lines later a BUILD FAILURE because the javadoc tool exited
> > with the following error:
> > Exit code: 1 -
> > /path/to/my/project/target/distro-javadoc-sources/<Dependency_Project_Artifact_Id>-<Version>-sources/module-info.java:10:
> > error: module not found on module source path
> >
> > But the source of the dependency seems to be fetched and unpacked
> > correctly to
> > /path/to/my/project/target/distro-javadoc-sources/<Dependency_Project_Artifact_Id>-<Version>-sources/
> > The line (10) where the error is is the module definition of the single
> > in that project.
> >
> > The generated javdoc options file contains only one module-source-path:
> > /path/to/my/project/target/site/apidocs/src which contains a single
> > empty folder named like the module of my project (not the dependency).
> >
> > Did anyone have a similar problem before? Any ideas what to try?
> >
> > If anyone wants to look at the whole pom or try to reproduce it, the
> > project is on github: https://github.com/fius/jvk in the folder project.
> > The only dependency of that project is also on github:
> > https://github.com/FIUS/ICGE2
> > For trying to get this to work I made some changes to both, which are
> > not merged yet. See these pull-requests:
> > https://github.com/FIUS/ICGE2/pull/186 and
> > https://github.com/FIUS/jvk/pull/71
> > For this testing I'm using version 2.3.5-Snapshot of the dependency and
> > just locally running mvn clean install in it instead of uploading it to
> > a maven repository.
> >
> > Regards,
> > Tim
> >
> > --
> > Tim Neumann (GPG-Key: B5BD 17C3 BD4A 7BA4)
> > stv. Referent für IT Betreung
> > Studierendenvertretung Uni Stuttgart
> > https://stuvus.uni-stuttgart.de
> >
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: [hidden email]
> > For additional commands, e-mail: [hidden email]
> >

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]