diff options
author | Jack Lloyd <[email protected]> | 2017-12-26 11:32:44 -0500 |
---|---|---|
committer | Jack Lloyd <[email protected]> | 2017-12-26 11:32:44 -0500 |
commit | d12b1369126f697402dee1cc4ab75f5bdad6fabf (patch) | |
tree | 725aca8c4a3909e082124eaf18acdaea23a66200 /src | |
parent | 010fc707ebe4ba8c9d11ff55ddaefe03e4dd5c33 (diff) |
Fix a couple Doxygen format errors [ci skip]
Diffstat (limited to 'src')
-rw-r--r-- | src/lib/pk_pad/emsa.h | 8 | ||||
-rw-r--r-- | src/lib/x509/x509_ca.h | 12 |
2 files changed, 11 insertions, 9 deletions
diff --git a/src/lib/pk_pad/emsa.h b/src/lib/pk_pad/emsa.h index f1175ca86..fe0785294 100644 --- a/src/lib/pk_pad/emsa.h +++ b/src/lib/pk_pad/emsa.h @@ -61,12 +61,12 @@ class BOTAN_PUBLIC_API(2,0) EMSA size_t key_bits) = 0; /** - * Prepare sig_algo for use in choose_sig_format for x509 certs, - * return padding info string - * @param sig_algo's oid and parameters will be set properly + * Prepare sig_algo for use in choose_sig_format for x509 certs + * * @param key used for checking compatibility with the encoding scheme * @param cert_hash_name is checked to equal the hash for the encoding - * @return padding string to be consumed by PK_signer + * @return algorithm identifier to signatures created using this key, + * padding method and hash. */ virtual AlgorithmIdentifier config_for_x509(const Private_Key& key, const std::string& cert_hash_name) const; diff --git a/src/lib/x509/x509_ca.h b/src/lib/x509/x509_ca.h index 4f1da51fa..bc5323e5b 100644 --- a/src/lib/x509/x509_ca.h +++ b/src/lib/x509/x509_ca.h @@ -193,6 +193,7 @@ BOTAN_PUBLIC_API(2,0) PK_Signer* choose_sig_format(const Private_Key& key, AlgorithmIdentifier& alg_id); /** +* @verbatim * Choose the default signature format for a certain public key signature * scheme. * @@ -200,6 +201,7 @@ BOTAN_PUBLIC_API(2,0) PK_Signer* choose_sig_format(const Private_Key& key, * Find an entry from src/build-data/oids.txt under [signature] of the form * <sig_algo>/<padding>[(<hash_algo>)] and add {"padding",<padding>} * to opts. +* @endverbatim * * @param key will be the key to choose a padding scheme for * @param opts contains additional options for building the certificate @@ -208,11 +210,11 @@ BOTAN_PUBLIC_API(2,0) PK_Signer* choose_sig_format(const Private_Key& key, * @param alg_id will be set to the chosen scheme * @return A PK_Signer object for generating signatures */ - PK_Signer* choose_sig_format(const Private_Key& key, - const std::map<std::string,std::string>& opts, - RandomNumberGenerator& rng, - const std::string& hash_fn, - AlgorithmIdentifier& alg_id); +PK_Signer* choose_sig_format(const Private_Key& key, + const std::map<std::string,std::string>& opts, + RandomNumberGenerator& rng, + const std::string& hash_fn, + AlgorithmIdentifier& alg_id); } |