Update Docs Again #239
Draft
Update Docs Again #239
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
lishaduck
force-pushed
the
update-docs
branch
2 times, most recently
from
8fe42ee to
3037711
Compare
lishaduck
added
enhancement
lishaduck
force-pushed
the
update-docs
branch
from
3037711 to
d1e8f99
Compare
lishaduck
force-pushed
the
update-docs
branch
from
d1e8f99 to
da97015
Compare
lishaduck
force-pushed
the
main
branch
4 times, most recently
from
bb68a12 to
e5e9b68
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.
Description
This PR updates the documentation again.
The docs now use macros to reduce the duplication between library, class, and constructor documentation.
Or at least, they will before this gets merged.
In addition, this might add
@immutableand@visibleForTestingannotations to more classes to better document files' public APIs and possibly add in aRepositoryclass to mark extenders as@immutable, along with updating names and such to make sure minimal implementation details are leaked.Type of Change