Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More and newer Javadoc links. #1386

Merged
merged 1 commit into from
Jan 30, 2025
Merged

More and newer Javadoc links. #1386

merged 1 commit into from
Jan 30, 2025

Conversation

copybara-service[bot]
Copy link
Contributor

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: 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

- 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
@copybara-service copybara-service bot merged commit b11598e into master Jan 30, 2025
@copybara-service copybara-service bot deleted the test_721101014 branch January 30, 2025 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant