[core] Update crypto module documentation, suitable for rustdocs. #469
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
This change allows us to view the crypto code documentation via `cargo doc`. Some of the section heading are moved around to keep similar concepts together and for markdown formatting. Signed-off-by: Fletcher Nichol <[email protected]>
| /// ******************************************* | ||
| // ******************************************* | ||
| // Key generation functions | ||
| // ******************************************* |
There was a problem hiding this comment.
The 3 to 2 slash commenting style change is to avoid this internal comment from being rendered as the function documentation in the next function.
|
|
|
📌 Commit c143b40 has been approved by |
thesentinels
pushed a commit
that referenced
this pull request
Apr 29, 2016
This change allows us to view the crypto code documentation via `cargo doc`. Some of the section heading are moved around to keep similar concepts together and for markdown formatting. Signed-off-by: Fletcher Nichol <[email protected]> Pull request: #469 Approved by: metadave
|
☀️ Test successful - travis |
smith
pushed a commit
that referenced
this pull request
May 2, 2016
This change allows us to view the crypto code documentation via `cargo doc`. Some of the section heading are moved around to keep similar concepts together and for markdown formatting. Signed-off-by: Fletcher Nichol <[email protected]> Pull request: #469 Approved by: metadave
jtimberman
pushed a commit
that referenced
this pull request
Jun 12, 2016
This change allows us to view the crypto code documentation via `cargo doc`. Some of the section heading are moved around to keep similar concepts together and for markdown formatting. Signed-off-by: Fletcher Nichol <[email protected]> Pull request: #469 Approved by: metadave
raskchanky
pushed a commit
that referenced
this pull request
Apr 16, 2019
This change allows us to view the crypto code documentation via `cargo doc`. Some of the section heading are moved around to keep similar concepts together and for markdown formatting. Signed-off-by: Fletcher Nichol <[email protected]> Pull request: #469 Approved by: metadave
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.
This change allows us to view the crypto code documentation via
cargo doc. Some of the section heading are moved around to keep similarconcepts together and for markdown formatting.
Signed-off-by: Fletcher Nichol [email protected]