Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation on a bunch of rnp_op_verify_t calls. #2258

Merged
merged 1 commit into from
Aug 24, 2024
Merged

Improve documentation on a bunch of rnp_op_verify_t calls. #2258

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions include/rnp/rnp.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2633,7 +2633,8 @@ RNP_API rnp_result_t rnp_op_sign_destroy(rnp_op_sign_t op);
* signatures, cleartext signed data and encrypted (and possibly signed) data.
* For the detached signature verification the function rnp_op_verify_detached_create()
* should be used.
* @param op pointer to opaque verification context
* @param op pointer to opaque verification context. When no longer needed must be destroyed
* via the rnp_op_verify_destroy() call.
* @param ffi
* @param input stream with signed data. Could not be NULL.
* @param output stream to write results to. Could not be NULL, but may be null output stream
Expand All @@ -2646,7 +2647,8 @@ RNP_API rnp_result_t rnp_op_verify_create(rnp_op_verify_t *op,
rnp_output_t output);

/** @brief Create verification operation context for detached signature.
* @param op pointer to opaque verification context
* @param op pointer to opaque verification context. When no longer needed must be destroyed
* via the rnp_op_verify_destroy() call.
* @param ffi
* @param input stream with raw data. Could not be NULL.
* @param signature stream with detached signature data
Expand Down Expand Up @@ -2700,7 +2702,9 @@ RNP_API rnp_result_t rnp_op_verify_get_signature_count(rnp_op_verify_t op, size_

/** @brief Get single signature information based on its index.
* @param op opaque verification context. Must be initialized and have execute() called on it.
* @param sig opaque signature context data will be stored here on success.
* @param sig opaque signature context data will be stored here on success. It is not needed
* to deallocate this structure manually, it will be destroyed together with op in
* rnp_op_verify_destroy() call.
* @return RNP_SUCCESS if call succeeded.
*/
RNP_API rnp_result_t rnp_op_verify_get_signature_at(rnp_op_verify_t op,
Expand Down