maven-javadoc-plugin icon indicating copy to clipboard operation
maven-javadoc-plugin copied to clipboard

[MJAVADOC-652] - Dependencies on the patch-module path

Open philsmart opened this issue 3 years ago • 4 comments

Add parameter to turn off support for the module path even if supported by the environment.

To bypass module-path and patch-module-path arguments from being created for Javadoc even if using Java 9 and your project declares support for modules e.g. includes an automatic module name.

Following this checklist to help us incorporate your contribution quickly and easily:

  • [x] https://issues.apache.org/jira/browse/MJAVADOC-652
  • [x] Each commit in the pull request should have a meaningful subject line and body.
  • [x] Format the pull request title like [MJAVADOC-XXX] - Fixes bug in ApproximateQuantiles, where you replace MJAVADOC-XXX with the appropriate JIRA issue. Best practice is to use the JIRA issue title in the pull request title and in the first line of the commit message.
  • [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • [x] Run mvn clean verify -Prun-its to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.

If your pull request is about ~20 lines of code you don't need to sign an Individual Contributor License Agreement if you are unsure please ask on the developers list.

To make clear that you license your contribution under the Apache License Version 2.0, January 2004 you have to acknowledge this by using the following check-box.

philsmart avatar May 12 '22 09:05 philsmart

Please add example project to IT test with twice executions - one without and one with new parameter. you can prepare invoker.properties

invoker.goals.1 = ...
invoker.buildResult.1 = failure

invoker.goals.2 = ... -DdisableModulePath=true
invoker.buildResult.2 = success

slawekjaranowski avatar May 12 '22 13:05 slawekjaranowski

I added the test project. However, both testing conditions will return success. The build is not actually failing (in the test project); you need to inspect the Javadoc @options file to see the patch-module discrepancy (which is causing a problem in a much larger project I work on).

philsmart avatar May 12 '22 16:05 philsmart

It is not good that we can't reproduce problem in test project ... We must find a way to reproduce, in other case that is a probability that problem is somewhere else.

slawekjaranowski avatar May 12 '22 16:05 slawekjaranowski

The issue of it using the patch-module path is reproducible in the test project. But I will see if I can get it to fail during the Javadoc construction

philsmart avatar May 13 '22 08:05 philsmart