diff options
| author | Neal H. Walfield <neal@pep.foundation> | 2019-05-07 11:12:21 +0200 |
|---|---|---|
| committer | Neal H. Walfield <neal@pep.foundation> | 2019-05-07 12:18:42 +0200 |
| commit | 381ecfedce31d38d6bd447d85a05f7d9a458c38b (patch) | |
| tree | fc9b245eb8a46bee88e9bdaac00c7efd91d70cfc /openpgp-ffi/include/sequoia/openpgp.h | |
| parent | 4ecdcafbb1a46a39e7fe54c2802c421c2160884d (diff) | |
openpgp: Rename TPKBuilder::default to TPKBuilder::new
- One would think that TPKBuilder::default would return something
filled with useful defaults, but it just returns a nearly empty
builder. Rename it to TPKBuilder::new, which is less misleading.
Diffstat (limited to 'openpgp-ffi/include/sequoia/openpgp.h')
| -rw-r--r-- | openpgp-ffi/include/sequoia/openpgp.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/openpgp-ffi/include/sequoia/openpgp.h b/openpgp-ffi/include/sequoia/openpgp.h index d985984e..1f612855 100644 --- a/openpgp-ffi/include/sequoia/openpgp.h +++ b/openpgp-ffi/include/sequoia/openpgp.h @@ -802,9 +802,13 @@ char *pgp_tpk_primary_user_id(pgp_tpk_t tpk); /* TPKBuilder */ /*/ -/// Creates a default `pgp_tpk_builder_t`. +/// Creates a new `pgp_tpk_builder_t`. +/// +/// The returned TPKBuilder is setup to only create a +/// certification-capable primary key using the default cipher suite. +/// You'll almost certainly want to add subkeys, and user ids. /*/ -pgp_tpk_builder_t pgp_tpk_builder_default(void); +pgp_tpk_builder_t pgp_tpk_builder_new(void); /*/ /// Generates a key compliant to [Autocrypt Level 1]. |