diff options
| author | Justus Winter <justus@sequoia-pgp.org> | 2019-01-02 16:58:46 +0100 |
|---|---|---|
| committer | Justus Winter <justus@sequoia-pgp.org> | 2019-01-02 16:58:46 +0100 |
| commit | 4c61e4c5caa421ace06733630bda85b19579946a (patch) | |
| tree | 0a436229e2ca3bc958233c853051253ec178940f /openpgp/src/crypto/asymmetric.rs | |
| parent | de44f79686b9b4caadb6eda4637e5ed7ea9298a7 (diff) | |
openpgp: Improve documentation.
Diffstat (limited to 'openpgp/src/crypto/asymmetric.rs')
| -rw-r--r-- | openpgp/src/crypto/asymmetric.rs | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/openpgp/src/crypto/asymmetric.rs b/openpgp/src/crypto/asymmetric.rs index 51d95934..b779176a 100644 --- a/openpgp/src/crypto/asymmetric.rs +++ b/openpgp/src/crypto/asymmetric.rs @@ -25,6 +25,12 @@ pub trait Signer { } /// A cryptographic key pair. +/// +/// A `KeyPair` is a combination of public and secret key. If both +/// are available in memory, a `KeyPair` is a convenient +/// implementation of [`Signer`]. +/// +/// [`Signer`]: trait.Signer.html pub struct KeyPair { public: Key, secret: mpis::SecretKey, |