summaryrefslogtreecommitdiffstats
path: root/openpgp-ffi
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2020-10-14 11:38:33 +0200
committerJustus Winter <justus@sequoia-pgp.org>2020-10-14 12:01:22 +0200
commit2079449be080b4da3cdc8c6f9972f4ac48e58aaf (patch)
treec3b4567348ff7e2f9dd4ffb514996351e1fb9498 /openpgp-ffi
parent57531dbe5b277a46982e4dd2b0ab6c20ebe43682 (diff)
Use 'Examples' for the examples section.
- See #480.
Diffstat (limited to 'openpgp-ffi')
-rw-r--r--openpgp-ffi/src/armor.rs10
-rw-r--r--openpgp-ffi/src/cert.rs4
-rw-r--r--openpgp-ffi/src/fingerprint.rs2
-rw-r--r--openpgp-ffi/src/keyid.rs4
-rw-r--r--openpgp-ffi/src/packet/key.rs2
-rw-r--r--openpgp-ffi/src/parse/stream.rs6
6 files changed, 14 insertions, 14 deletions
diff --git a/openpgp-ffi/src/armor.rs b/openpgp-ffi/src/armor.rs
index 9421e783..71ee8539 100644
--- a/openpgp-ffi/src/armor.rs
+++ b/openpgp-ffi/src/armor.rs
@@ -68,7 +68,7 @@ fn int_to_reader_mode(mode: c_int) -> armor::ReaderMode {
///
/// A filter that strips ASCII Armor from a stream of data.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #include <assert.h>
@@ -149,7 +149,7 @@ pub extern "C" fn pgp_armor_reader_from_file(errp: Option<&mut *mut crate::error
/// Creates a `Reader` from a buffer.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #include <assert.h>
@@ -220,7 +220,7 @@ fn pgp_armor_reader_from_bytes(b: *const u8, len: size_t,
/// has not been encountered yet (try reading some data first!), this
/// function returns PGP_ARMOR_KIND_ANY.
///
-/// # Example
+/// # Examples
///
/// See [this] example.
///
@@ -250,7 +250,7 @@ pub extern "C" fn pgp_armor_reader_kind(reader: *const Reader)
/// allocated with `malloc`, and the caller is responsible for freeing
/// both the array and the strings.
///
-/// # Example
+/// # Examples
///
/// See [this] example.
///
@@ -306,7 +306,7 @@ pub extern "C" fn pgp_armor_reader_headers(errp: Option<&mut *mut crate::error::
/// Note: You must call `pgp_armor_writer_finalize` to deallocate this
/// writer.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #define _GNU_SOURCE
diff --git a/openpgp-ffi/src/cert.rs b/openpgp-ffi/src/cert.rs
index c3893399..84fd520d 100644
--- a/openpgp-ffi/src/cert.rs
+++ b/openpgp-ffi/src/cert.rs
@@ -186,7 +186,7 @@ fn int_to_reason_for_revocation(code: c_int) -> ReasonForRevocation {
///
/// This function does *not* consume `cert`.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #include <assert.h>
@@ -881,7 +881,7 @@ pub extern "C" fn pgp_cert_parser_free(parser: Option<&mut CertParserWrapper>)
/// Creates a default `pgp_cert_builder_t`.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #include <assert.h>
diff --git a/openpgp-ffi/src/fingerprint.rs b/openpgp-ffi/src/fingerprint.rs
index 76303631..716d2d23 100644
--- a/openpgp-ffi/src/fingerprint.rs
+++ b/openpgp-ffi/src/fingerprint.rs
@@ -48,7 +48,7 @@ fn pgp_fingerprint_from_bytes(buf: *const u8,
/// Reads a hexadecimal fingerprint.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #include <assert.h>
diff --git a/openpgp-ffi/src/keyid.rs b/openpgp-ffi/src/keyid.rs
index 1cbd41b8..c5ed5dbe 100644
--- a/openpgp-ffi/src/keyid.rs
+++ b/openpgp-ffi/src/keyid.rs
@@ -36,7 +36,7 @@ pub struct KeyID(openpgp::KeyID);
/// Reads a binary key ID.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #include <assert.h>
@@ -62,7 +62,7 @@ fn pgp_keyid_from_bytes(id: *const u8) -> *mut KeyID {
/// Reads a hex-encoded Key ID.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #include <assert.h>
diff --git a/openpgp-ffi/src/packet/key.rs b/openpgp-ffi/src/packet/key.rs
index 1ec3b62a..60d2ae3c 100644
--- a/openpgp-ffi/src/packet/key.rs
+++ b/openpgp-ffi/src/packet/key.rs
@@ -108,7 +108,7 @@ fn pgp_key_has_unencrypted_secret(key: *const Key) -> bool
/// This function takes ownership of `key`. On failure, `key` is
/// deallocated.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #include <assert.h>
diff --git a/openpgp-ffi/src/parse/stream.rs b/openpgp-ffi/src/parse/stream.rs
index d1c2f625..747452a0 100644
--- a/openpgp-ffi/src/parse/stream.rs
+++ b/openpgp-ffi/src/parse/stream.rs
@@ -535,7 +535,7 @@ impl VerificationHelper for VHelper {
/// No attempt is made to decrypt any encryption packets. These are
/// treated as opaque containers.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #define _GNU_SOURCE
@@ -663,7 +663,7 @@ pub struct DetachedVerifier(openpgp::parse::stream::DetachedVerifier<'static, VH
/// Verifies a detached OpenPGP signature.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #define _GNU_SOURCE
@@ -904,7 +904,7 @@ impl DecryptionHelper for DHelper {
///
/// Note: all of the parameters are required; none may be NULL.
///
-/// # Example
+/// # Examples
///
/// ```c
/// #define _GNU_SOURCE