summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2019-09-02 14:50:57 +0200
committerJustus Winter <justus@sequoia-pgp.org>2019-09-02 15:38:57 +0200
commit005ea8925316a5ac837ff207a783c21b00b5254c (patch)
treebf8d81377843618d3e78f3bda5ee74db3f574def
parent341d518d86d9b0c4237e56da6b88d87edc2c5f36 (diff)
openpgp: Improve documentation.
-rw-r--r--openpgp/src/constants.rs14
1 files changed, 12 insertions, 2 deletions
diff --git a/openpgp/src/constants.rs b/openpgp/src/constants.rs
index a7a0501c..e948c922 100644
--- a/openpgp/src/constants.rs
+++ b/openpgp/src/constants.rs
@@ -541,9 +541,19 @@ impl Arbitrary for AEADAlgorithm {
pub enum CompressionAlgorithm {
/// Null compression.
Uncompressed,
- /// DEFLATE
+ /// DEFLATE Compressed Data.
+ ///
+ /// See [RFC 1951] for details. [Section 9.3 of RFC 4880]
+ /// recommends that this algorithm should be implemented.
+ ///
+ /// [RFC 1951]: https://tools.ietf.org/html/rfc1951
+ /// [Section 9.3 of RFC 4880]: https://tools.ietf.org/html/rfc4880#section-9.3
Zip,
- /// ZLIB
+ /// ZLIB Compressed Data.
+ ///
+ /// See [RFC 1950] for details.
+ ///
+ /// [RFC 1950]: https://tools.ietf.org/html/rfc1950
Zlib,
/// bzip2
BZip2,