diff options
| author | Neal H. Walfield <neal@pep.foundation> | 2019-05-17 11:15:06 +0200 |
|---|---|---|
| committer | Neal H. Walfield <neal@pep.foundation> | 2019-05-17 11:15:06 +0200 |
| commit | 6405b3626bac09e332eb534a0adf1f9f049e033b (patch) | |
| tree | 77701db14822310beeee1e2ca471c897c6b50e30 /openpgp-ffi/include | |
| parent | 3ffbc7318288ab65850c13b35e5bd0785e9528d5 (diff) | |
openpgp-ffi: Fix documentation.
- The documentation for pgp_tpk_key_iter_all and
pgp_tpk_key_iter_valid was backwards.
Diffstat (limited to 'openpgp-ffi/include')
| -rw-r--r-- | openpgp-ffi/include/sequoia/openpgp.h | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/openpgp-ffi/include/sequoia/openpgp.h b/openpgp-ffi/include/sequoia/openpgp.h index b1b2ab3a..13f51d24 100644 --- a/openpgp-ffi/include/sequoia/openpgp.h +++ b/openpgp-ffi/include/sequoia/openpgp.h @@ -837,14 +837,6 @@ int pgp_tpk_is_tsk(pgp_tpk_t tpk); pgp_user_id_binding_iter_t pgp_tpk_user_id_binding_iter (pgp_tpk_t tpk); /*/ -/// Returns an iterator over the live and unrevoked `Key`s in a TPK. -/// -/// Compare with `pgp_tpk_key_iter_valid`, which doesn'filters out -/// expired and revoked keys by default. -/*/ -pgp_tpk_key_iter_t pgp_tpk_key_iter_all (pgp_tpk_t tpk); - -/*/ /// Returns an iterator over all `Key`s in a TPK. /// /// That is, this returns an iterator over the primary key and any @@ -860,9 +852,17 @@ pgp_tpk_key_iter_t pgp_tpk_key_iter_all (pgp_tpk_t tpk); /// /// A valid `Key` has at least one good self-signature. /// -/// Compare with `pgp_tpk_key_iter_all`, which filters out expired and +/// Compare with `pgp_tpk_key_iter_valid`, which filters out expired and /// revoked keys. /*/ +pgp_tpk_key_iter_t pgp_tpk_key_iter_all (pgp_tpk_t tpk); + +/*/ +/// Returns an iterator over the live and unrevoked `Key`s in a TPK. +/// +/// Compare with `pgp_tpk_key_iter_all`, which doesn't filter out +/// expired and revoked keys by default. +/*/ pgp_tpk_key_iter_t pgp_tpk_key_iter_valid (pgp_tpk_t tpk); /*/ |