ndk: Move library documentation to modules #290
Merged
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
Member
Author
|
With this PR we go from:
To:
|
MarijnS95
added
blocking a release
MarijnS95
force-pushed
the
doc-improve
branch
2 times, most recently
from
d1a0215 to
9a0b3a0
Compare
20 tasks
Instead of having an outdated overview of modules and their contents in the library documentation, move this to the module documentation header. Rustdoc already provides a clickable link for every module (these manual list didn't include _any_ links), and also includes the first sentence/paragraph from this module documentation. This also inserts some missing `struct` documentation and cleans up existing references to link to the NDK docs more often and specify exactly what type it is wrapping, instead of linking to the "rather useless" `ffi` representation for that NDK type.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Instead of having an outdated overview of modules and their contents in the library documentation, move this to the module documentation header. Rustdoc already provides a clickable link for every module (these manual list didn't include any links), and also includes the first sentence/paragraph from this module documentation.
This also inserts some missing
structdocumentation and cleans up existing references to link to the NDK docs more often and specify exactly what type it is wrapping, instead of linking to the "rather useless"ffirepresentation for that NDK type.