Skip to content

Commit

Permalink
More and newer Javadoc links.
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
cpovirk authored and Google Java Core Libraries committed Jan 30, 2025
1 parent c876717 commit 83692e7
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion android/guava/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@
<offlineLinks>
<!-- We need local copies of some of these for 2 reasons: a User-Agent problem (https://stackoverflow.com/a/47891403/28465) and an SSL problem (https://issues.apache.org/jira/browse/MJAVADOC-507). If we choose to work around the User-Agent problem, we can go back to <links>, sidestepping the SSL problem. -->
<offlineLink>
<url>https://static.javadoc.io/com.google.j2objc/j2objc-annotations/1.1/</url>
<url>https://javadoc.io/doc/com.google.j2objc/j2objc-annotations/latest/</url>
<location>${project.basedir}/javadoc-link/j2objc-annotations</location>
</offlineLink>
</offlineLinks>
Expand Down
2 changes: 1 addition & 1 deletion guava/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@
<offlineLinks>
<!-- We need local copies of some of these for 2 reasons: a User-Agent problem (https://stackoverflow.com/a/47891403/28465) and an SSL problem (https://issues.apache.org/jira/browse/MJAVADOC-507). If we choose to work around the User-Agent problem, we can go back to <links>, sidestepping the SSL problem. -->
<offlineLink>
<url>https://static.javadoc.io/com.google.j2objc/j2objc-annotations/1.1/</url>
<url>https://javadoc.io/doc/com.google.j2objc/j2objc-annotations/latest/</url>
<location>${project.basedir}/javadoc-link/j2objc-annotations</location>
</offlineLink>
</offlineLinks>
Expand Down

0 comments on commit 83692e7

Please sign in to comment.