diff options
| author | Justus Winter <justus@sequoia-pgp.org> | 2019-01-21 12:23:23 +0100 |
|---|---|---|
| committer | Justus Winter <justus@sequoia-pgp.org> | 2019-01-21 12:23:23 +0100 |
| commit | 4bd93e6249446081d4eefd04145ce328ae763a72 (patch) | |
| tree | 37947e61be69986eecd4018a093b17a0f30eb74e | |
| parent | 2c2ce24b4eb02beae3365a705a7db49636711241 (diff) | |
openpgp-ffi: Improve module documentation.
| -rw-r--r-- | openpgp-ffi/src/fingerprint.rs | 10 | ||||
| -rw-r--r-- | openpgp-ffi/src/keyid.rs | 8 | ||||
| -rw-r--r-- | openpgp-ffi/src/packet_pile.rs | 3 | ||||
| -rw-r--r-- | openpgp-ffi/src/tpk.rs | 2 | ||||
| -rw-r--r-- | openpgp-ffi/src/tsk.rs | 2 |
5 files changed, 19 insertions, 6 deletions
diff --git a/openpgp-ffi/src/fingerprint.rs b/openpgp-ffi/src/fingerprint.rs index d177029d..f53b2dbc 100644 --- a/openpgp-ffi/src/fingerprint.rs +++ b/openpgp-ffi/src/fingerprint.rs @@ -1,8 +1,14 @@ -//! Handles Fingerprints. +//! Fingerprints. +//! +//! A fingerprint uniquely identifies a public key. For more details +//! about how a fingerprint is generated, see [Section 12.2 of RFC +//! 4880]. +//! +//! [Section 12.2 of RFC 4880]: https://tools.ietf.org/html/rfc4880#section-12.2 //! //! Wraps [`sequoia-openpgp::Fingerprint`]. //! -//! [`sequoia-openpgp::Fingerprint`]: ../../../sequoia_openpgp/enum.Fingerprint.html +//! [`sequoia-openpgp::Fingerprint`]: ../../sequoia_openpgp/enum.Fingerprint.html use std::hash::{Hash, Hasher}; use std::ptr; diff --git a/openpgp-ffi/src/keyid.rs b/openpgp-ffi/src/keyid.rs index c3b185ae..4a22b7b6 100644 --- a/openpgp-ffi/src/keyid.rs +++ b/openpgp-ffi/src/keyid.rs @@ -1,4 +1,10 @@ -//! Handles KeyIDs. +//! KeyIDs. +//! +//! A KeyID is a fingerprint fragment. It identifies a public key, +//! but is easy to forge. For more details about how a KeyID is +//! generated, see [Section 12.2 of RFC 4880]. +//! +//! [Section 12.2 of RFC 4880]: https://tools.ietf.org/html/rfc4880#section-12.2 //! //! Wraps [`sequoia-openpgp::KeyID`]. //! diff --git a/openpgp-ffi/src/packet_pile.rs b/openpgp-ffi/src/packet_pile.rs index d8ae3c38..a08aa229 100644 --- a/openpgp-ffi/src/packet_pile.rs +++ b/openpgp-ffi/src/packet_pile.rs @@ -1,4 +1,5 @@ -//! Handles PacketPiles. +//! `PacketPile`s, deserialized sequences of OpenPGP messages. +//! //! //! Wraps [`sequoia-openpgp::PacketPile`]. //! diff --git a/openpgp-ffi/src/tpk.rs b/openpgp-ffi/src/tpk.rs index df41a93e..04562d99 100644 --- a/openpgp-ffi/src/tpk.rs +++ b/openpgp-ffi/src/tpk.rs @@ -1,4 +1,4 @@ -//! Handles TPKs. +//! Transferable public keys. //! //! Wraps [`sequoia-openpgp::TPK`] and [related functionality]. //! diff --git a/openpgp-ffi/src/tsk.rs b/openpgp-ffi/src/tsk.rs index f98b364e..76103096 100644 --- a/openpgp-ffi/src/tsk.rs +++ b/openpgp-ffi/src/tsk.rs @@ -1,4 +1,4 @@ -//! Handles TSKs. +//! Transferable secret keys. //! //! Wraps [`sequoia-openpgp::TSK`]. //! |