Added documentation to the sha256.rs ciphers module. #81
Conversation
This file contains 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
alexfertel
approved these changes
Jun 11, 2024
Comment on lines
+3
to
+11
| // The data to process. | ||
| data: Vec<u8>, | ||
| // The length of the data. | ||
| len: usize, | ||
| // The total length of the data. | ||
| total_len: usize, | ||
| // A flag indicating if the buffer has a single byte. | ||
| single: bool, | ||
| // A flag indicating if the buffer has been fully processed. |
There was a problem hiding this comment.
It's fine here since this struct is private, but note that these should be doc comments with ///, i.e., fields should also be documented in docs.
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.
No description provided.