diff options
author | Neal H. Walfield <neal@pep.foundation> | 2019-11-06 15:39:42 +0100 |
---|---|---|
committer | Neal H. Walfield <neal@pep.foundation> | 2019-11-06 15:39:42 +0100 |
commit | 4030f8aca7d47d4cf9b076dd67c8f3344b77728c (patch) | |
tree | 286f93d462a46555e09c93937feeadfd55c681f3 /openpgp-ffi | |
parent | 8693a005c08e1c84d693fe7baa154f8785007520 (diff) |
openpgp-ffi: Improve documentation.
Diffstat (limited to 'openpgp-ffi')
-rw-r--r-- | openpgp-ffi/include/sequoia/openpgp.h | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/openpgp-ffi/include/sequoia/openpgp.h b/openpgp-ffi/include/sequoia/openpgp.h index 071d71ff..66309c03 100644 --- a/openpgp-ffi/include/sequoia/openpgp.h +++ b/openpgp-ffi/include/sequoia/openpgp.h @@ -621,15 +621,16 @@ void pgp_tpk_key_iter_unencrypted_secret (pgp_tpk_key_iter_t iter, bool unencrypted_secret); /*/ -/// Returns the next key. Returns NULL if there are no more elements. +/// Returns a reference to the next key. Returns NULL if there are no +/// more elements. /// -/// If sigo is not NULL, stores the current self-signature (if any) in -/// *sigo. (Note: subkeys always have signatures, but a primary key -/// may not have a direct signature, and there might not be any user -/// ids.) +/// If signature is not NULL, stores the current self-signature (if +/// any) in *signature. (Note: subkeys always have signatures, but a +/// primary key may not have a direct signature, and there might not +/// be any user ids.) /// -/// If rso is not NULL, this stores the key's revocation status in -/// *rso. +/// If rev is not NULL, this stores the key's revocation status in +/// *rev. /*/ pgp_key_t pgp_tpk_key_iter_next (pgp_tpk_key_iter_t iter, pgp_signature_t *signature, |