Add docs and some minor cleanups #134
Draft
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
Signed-off-by: Simo Sorce <[email protected]>
simo5
force-pushed
the
adddocs
branch
3 times, most recently
from
9167b62 to
18a122f
Compare
With #[macro_export] macros are declared public crate interfaces, but that is not what we really want to do with these macros. We just want to make them available to all modules within the crate. Use the correct method to do that. Signed-off-by: Simo Sorce <[email protected]>
Some functions and variables were made public, but didn't need to, tidy up access. Signed-off-by: Simo Sorce <[email protected]>
This crate exposes only three public functions which are the official entrypoints for the PKCS#11 interface. Document them with additional pointers to the spec. Signed-off-by: Simo Sorce <[email protected]>
Signed-off-by: Simo Sorce <[email protected]>
This target build both public and internal doc strings in the standard rustdoc documentation. Signed-off-by: Simo Sorce <[email protected]>
Signed-off-by: Simo Sorce <[email protected]>
Jakuje
reviewed
Dec 17, 2024
| /// | ||
| /// Each slot is identified by a slot number (a u32 quantity) and can | ||
| /// optionally have a customized description and manufacturer string. | ||
| /// If not description or manufacturer strings are provided then default |
There was a problem hiding this comment.
/// If no description nor manufacturer strings are provided then default
| @@ -130,12 +203,19 @@ impl Config { | |||
| } | |||
| } | |||
|
|
|||
| /// Generates a configuration structure from the named file which must | |||
| /// be a properly formatted confgiuation file in toml format. | |||
There was a problem hiding this comment.
/// be a properly formatted configuration file in toml format.
| @@ -156,6 +236,9 @@ impl Config { | |||
| Ok(conf) | |||
| } | |||
|
|
|||
| /// Ensure all slot numbers are consistents, and allocates new slot | |||
There was a problem hiding this comment.
/// Ensure all slot numbers are consistent, and allocates new slot
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 PR adds documentation for the kryoptic_pkcs11 crate.
Additionally add documentation for internal functions too.
Do some cosmetic build cleanups as well.
Fixes #105