glome: improve public API documentation in glome.h#226
Open
FreezB11 wants to merge 1 commit into
Open
Conversation
Document all parameters, ownership semantics, and appropriate use cases for glome_generate_key, glome_derive_key, and glome_tag.
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
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.
Summary
Improves the documentation of the three public functions in
glome.has requested in #167.The existing comments were single-sentence descriptions that gave no guidance on parameter ownership, buffer requirements, or when to use each function. This change replaces them with detailed doc comments covering all of that.
Changes
glome_generate_keyglome_derive_keyglome_tagverify=false) for the sender and tag verification (verify=true) for the receivertagdepending on the value ofverifyCloses #167.