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

The package overview documentation is not part of the output JavaDocs #926

Open
toddjonker opened this issue Aug 21, 2024 · 1 comment
Open

Comments

@toddjonker
Copy link
Contributor

The source tree includes overview content that is supposed to be part of the JavaDoc entry page. This is critical first-contact guidance to direct new users to how to approach the library, and sets important global expectations such as thread safety, non-canonicalization, and so on.

However, this content is not present in the published JavaDocs, so something has gone awry in the build process.

@toddjonker
Copy link
Contributor Author

Related: #497 : A large number of implementation-detail classes are also being erroneously documented, which I reported 13 months ago.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant