diff options
| author | cpovirk <cpovirk@google.com> | 2019-10-04 12:44:16 -0700 |
|---|---|---|
| committer | Chris Povirk <beigetangerine@gmail.com> | 2019-10-04 16:22:56 -0400 |
| commit | 1370e8f34be27a66c4560e23c17bf7c87fba7229 (patch) | |
| tree | 75c3d44de40585e4010865c6d3926b71f0fb4c92 /jimfs | |
| parent | e8a24aa250bd49d1744753929e49e1cd10f816cf (diff) | |
| download | jimfs-1370e8f34be27a66c4560e23c17bf7c87fba7229.tar.gz | |
Prepare Javadoc for Java 11, and make other improvements:
- Move nearly all Javadoc configuration to the parent POM.
- Update Guava and ICU4J link locations. The current links resolve to the Javadoc -- but only after a redirect, which Javadoc doesn't like: https://bugs.openjdk.java.net/browse/JDK-8190312
- Update maven-javadoc-plugin to 3.1.1. (This version knows how to work around the aforementioned redirect problem, should it happen again.)
- Add links to Checker Framework. For some reason, this isn't working under Java 11. I haven't investigated.
- Disable detectJavaApiLink, and fill in https://docs.oracle.com/javase/9/docs/api/ for Java 8 and https://docs.oracle.com/en/java/javase/11/docs/api/ for newer versions. (I've tested only with Java 8 and 11, so hopefully the "newer versions" behavior is OK for 9 and 10.)
It does look like it may be necessary to duplicate all the links in 3 places :\
This is all in service of preventing:
[ERROR] Exit code: 1 - javadoc: error - The code being documented uses modules but the packages defined in https://docs.oracle.com/javase/9/docs/api/ are in the unnamed module.
Traditionally we solve this problem by setting <source>8</source> on Javadoc (CL 235241314, CL 236159968). That would probably work here, but I've been experimenting with <source>9</source> (for proper modules support in jimfs), so that might not be an option soon. Or maybe it still would be, but I'd have to exclude module-info.java, but then I wonder if that will trigger modules problems? In any case, it seems more future-proof to solve this the right(?) way.
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=272937179
Diffstat (limited to 'jimfs')
| -rw-r--r-- | jimfs/pom.xml | 8 |
1 files changed, 0 insertions, 8 deletions
diff --git a/jimfs/pom.xml b/jimfs/pom.xml index 6c8f9c8..d4b5ba1 100644 --- a/jimfs/pom.xml +++ b/jimfs/pom.xml @@ -99,15 +99,7 @@ <plugin> <artifactId>maven-javadoc-plugin</artifactId> <configuration> - <encoding>UTF-8</encoding> - <docencoding>UTF-8</docencoding> - <charset>UTF-8</charset> <excludePackageNames>com.google.jimfs.internal</excludePackageNames> - <links> - <link>http://google.github.io/guava/releases/${guava.version}/api/docs/</link> - <link>http://icu-project.org/apiref/icu4j/</link> - <link>https://docs.oracle.com/javase/9/docs/api/</link> - </links> </configuration> <executions> <execution> |