Skip to content

Commit b11598e

Browse files
cpovirkGoogle Java Core Libraries
authored andcommitted
More and newer Javadoc links.
- For Truth: the J2ObjC annotations and the Error Prone annotations - For Guava: the latest version of the J2ObjC annotations (I'm still using `linkoffline` for the J2ObjC annotations at javadoc.io, even though at least one of the two problems we had with that before has possibly [been solved](maxcellent/javadoc.io#20): I'm not sure if it has been completely solved, and I haven't looked into the second problem at all. Note that, if we do want to use plain `link`, we may need to fiddle with the exact URL that we use. The one that I'm using now is where we ultimately want the user to end up, so that might be better than any indirect URL that we might need in order to use plain `link`.) Note that the Truth configuration works well for `mvn javadoc:aggregate`, which is what we use to generate truth.dev/api. For `mvn javadoc:javadoc`, it leads to non-fatal "errors": ``` [ERROR] The given File link: /usr/local/google/home/cpovirk/tmp.W4DFN5mMtK/git/core/javadoc-link/j2objc-annotations is not a dir. [ERROR] Error fetching link: /usr/local/google/home/cpovirk/tmp.W4DFN5mMtK/git/core/javadoc-link/j2objc-annotations. Ignored it. ``` It's possible that we'll see these during the release process. If they ever become true errors, I can mess with the configuration some more. (I think that this kind of "error" is the reason that I didn't try to share the Javadoc config for _Guava_ across modules.) RELNOTES=n/a PiperOrigin-RevId: 721364579
1 parent 2e32079 commit b11598e

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
com.google.j2objc.annotations

pom.xml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,13 +247,20 @@
247247
<charset>UTF-8</charset>
248248
<overview>overview.html</overview>
249249
<detectJavaApiLink>false</detectJavaApiLink>
250+
<offlineLinks>
251+
<!-- We use offlineLink here for reasons discussed in the Guava pom.xml. -->
252+
<offlineLink>
253+
<url>https://javadoc.io/doc/com.google.j2objc/j2objc-annotations/latest/</url>
254+
<location>${project.basedir}/javadoc-link/j2objc-annotations</location>
255+
</offlineLink>
256+
</offlineLinks>
250257
<links>
251-
<!-- TODO(cpovirk): Link to the version that we depend on? -->
252258
<link>https://guava.dev/releases/snapshot-jre/api/docs</link>
253259
<link>https://protobuf.dev/reference/java/api-docs/</link>
254260
<link>https://junit.org/junit4/javadoc/latest/</link>
255261
<link>https://docs.oracle.com/en/java/javase/21/docs/api/</link>
256262
<link>https://jspecify.dev/docs/api/</link>
263+
<link>https://errorprone.info/api/latest/</link>
257264
</links>
258265
<sourceFileExcludes>
259266
<sourceFileExclude>**/super/**/*.java</sourceFileExclude>

0 commit comments

Comments
 (0)