Upgrade Maven Javadoc Plugin to 3.1.0 #3476
Conversation
Additionally added wildcard syntax to the list of excluded package names due to failing without it after the upgrade
|
thanks! I'll import this shortly! |
guava/pom.xml
Outdated
| @@ -128,7 +128,7 @@ | |||
| <sourcepath>${project.build.sourceDirectory}:${project.build.directory}/jdk-sources</sourcepath> | |||
|
|
|||
| <!-- Passing `-subpackages com.google.common` breaks things, so we explicitly exclude everything else instead. --> | |||
| <excludePackageNames>com.google.common.base.internal,com.google.thirdparty.publicsuffix,com.oracle,com.sun,java,javax,jdk,org,sun</excludePackageNames> | |||
| <excludePackageNames>com.google.common.base.internal.*,com.google.thirdparty.publicsuffix.*,com.oracle.*,com.sun.*,java.*,javax.*,jdk.*,org.*,sun.*</excludePackageNames> | |||
There was a problem hiding this comment.
This PR produces a change in behavior: With this PR applied, the generated Javadoc contains entries for com.google.common.base.internal, com.google.thirdparty.publicsuffix, and jdk. Perhaps we need the .* only when that exact package doesn't exist?
Maybe you can find a way that works, but it feels unfortunate to have to further hardcode which packages exist. I guess we may need to cross this bridge eventually, unless we can hope that a future change to the Maven Javadoc Plugin will undo this change?
There was a problem hiding this comment.
Good catch, it looks like I can use the wildcard :* instead of .* which will exclude those exact packages, reference.
I will try test this later.
There was a problem hiding this comment.
Good catch, it looks like I can use the wildcard
:*instead of.*which will exclude those exact packages, reference.
I will try test this later.
Please ignore this comment, i misread the documentation
…nt the top level package getting included in the javadoc.
|
Butchered this branch, reopened new PR #3478 |
Upgrade Maven Javadoc Plugin from 3.0.1 to 3.1.0
Additionally added wildcard syntax to the list of excluded package names due to failing without it after the upgrade
Comment from @njhill in PR #3370 notes a javadoc plugin issue with JDK 11 that should be resolved in this most recent version.