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

Omit sources from generated Javadoc #7597

Open
cpovirk opened this issue Jan 3, 2025 · 1 comment
Open

Omit sources from generated Javadoc #7597

cpovirk opened this issue Jan 3, 2025 · 1 comment
Labels
P3 no SLO package=general type=api-docs Change/add API documentation

Comments

@cpovirk
Copy link
Member

cpovirk commented Jan 3, 2025

When we build Javadoc, we set linksource. That causes the Javadoc tool to generate links from text like public interface Multimap in https://guava.dev/Multimap. Those links go to pages like https://guava.dev/releases/snapshot-jre/api/docs/src-html/com/google/common/collect/Multimap.html#line-164.

I somewhat suspect that no one cares about these pages: If they want source, they'll look in GitHub or in the source jar for a release or snapshot.

Additionally, these pages force the generated Javadoc to change even for implementation changes (example output changes from input changes).

And any additional page presumably slows down downloading history, switching branches, and deploying the guava.dev. site.

I'm not sure I'll even bother to remove linksource, but I'm thinking about it, so let me know if that would cause a problem for you. If I do try it, and if it goes well, I might even consider removing some of the existing sources....

@cpovirk cpovirk added P3 no SLO package=general type=api-docs Change/add API documentation labels Jan 3, 2025
@cpovirk
Copy link
Member Author

cpovirk commented Jan 6, 2025

(If we cared enough, I'm sure we could rewrite the links to point to GitHub.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3 no SLO package=general type=api-docs Change/add API documentation
Projects
None yet
Development

No branches or pull requests

1 participant