aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/pubkey/eckcdsa
diff options
context:
space:
mode:
authorRenĂ© Korthaus <[email protected]>2016-10-18 11:41:33 +0200
committerRenĂ© Korthaus <[email protected]>2016-10-19 09:13:38 +0200
commit61a7875fb261a049c70382517e83176b4108bb61 (patch)
tree0cf884b160918002abb72c53868152fa574668fb /src/lib/pubkey/eckcdsa
parent47532b63e947e020df15a03d91f9d67657cd11dd (diff)
Improve pubkey doxygen [ci skip]
Diffstat (limited to 'src/lib/pubkey/eckcdsa')
-rw-r--r--src/lib/pubkey/eckcdsa/eckcdsa.h9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/lib/pubkey/eckcdsa/eckcdsa.h b/src/lib/pubkey/eckcdsa/eckcdsa.h
index 09ee34ed5..be5daf2da 100644
--- a/src/lib/pubkey/eckcdsa/eckcdsa.h
+++ b/src/lib/pubkey/eckcdsa/eckcdsa.h
@@ -28,6 +28,11 @@ class BOTAN_DLL ECKCDSA_PublicKey : public virtual EC_PublicKey
const PointGFp& public_point) :
EC_PublicKey(dom_par, public_point) {}
+ /**
+ * Load a public key.
+ * @param alg_id the X.509 algorithm identifier
+ * @param key_bits X.509 subject public key info structure
+ */
ECKCDSA_PublicKey(const AlgorithmIdentifier& alg_id,
const secure_vector<byte>& key_bits) :
EC_PublicKey(alg_id, key_bits) {}
@@ -67,7 +72,7 @@ class BOTAN_DLL ECKCDSA_PrivateKey : public ECKCDSA_PublicKey,
public:
/**
- * Load a private key
+ * Load a private key.
* @param alg_id the X.509 algorithm identifier
* @param key_bits PKCS #8 structure
*/
@@ -76,7 +81,7 @@ class BOTAN_DLL ECKCDSA_PrivateKey : public ECKCDSA_PublicKey,
EC_PrivateKey(alg_id, key_bits, true) {}
/**
- * Generate a new private key
+ * Create a private key.
* @param rng a random number generator
* @param domain parameters to used for this key
* @param x the private key (if zero, generate a new random key)