add package summaries #1511
Merged
add package summaries #1511
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stephengold
added
the
Documentation
stephengold
force-pushed
the
sgold-packageinfo
branch
from
361fb2b to
2812805
Compare
Member
Author
|
Perhaps "every package" was too ambitious. A lot of JME's codebase remains mysterious, at least to me! |
stephengold
force-pushed
the
sgold-packageinfo
branch
from
5bc8b0f to
e4f88f0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The purpose of this pull request is to ensure that every package in the merged javadoc includes a summary description.
Some JME packages have "package-info.java", and some of the older ones have "package.html", but most lack any summary description whatsoever. This is glaring if you browse the merged javadoc on the web.