kernel: Update documentation to utilities and debug #4197
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
alistair23
approved these changes
Oct 10, 2024
brghena
reviewed
Oct 14, 2024
kernel/src/debug.rs
Outdated
| /// needed so the debug!() macros have a reference to the object to use. | ||
| /// Static variable that holds the kernel's reference to the debug tool. | ||
| /// | ||
| /// This is needed so the debug!() macros have a reference to the object to use. |
There was a problem hiding this comment.
Suggested change
| /// This is needed so the debug!() macros have a reference to the object to use. | |
| /// This is needed so the `debug!()` macros have a reference to the object to use. |
kernel/src/utilities/copy_slice.rs
Outdated
| /// are not the same length. This is a non-panicing version of slice::copy_from_slice. | ||
| /// Copy a non-overlapping slice from `src` to `self`. | ||
| /// | ||
| /// This is a non-panicing version of [`slice::copy_from_slice`]. |
There was a problem hiding this comment.
Suggested change
| /// This is a non-panicing version of [`slice::copy_from_slice`]. | |
| /// This is a non-panicking version of [`slice::copy_from_slice`]. |
Add documentation for missing types, add rustdoc links, wrap lines, format header comments.
Also reformat comments.
54c8fd7 to
8262484
Compare
|
Updated |
lschuermann
approved these changes
Oct 20, 2024
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.
Pull Request Overview
This adds comments, formats comments, adds rustdoc links around the kernel::utilities module and Tock registers.
This makes the source files more consistent and improves the generated rustdoc HTML.
Testing Strategy
travis
TODO or Help Wanted
n/a
Documentation Updated
/docs, or no updates are required.Formatting
make prepush.