From 6bdb59120967fe129991f552c6cfd267d1c83e13 Mon Sep 17 00:00:00 2001
From: lloyd <lloyd@randombit.net>
Date: Mon, 13 Oct 2008 02:23:43 +0000
Subject: Add Doxygen comments to dh.h (from InSiTo)

---
 src/pubkey/dh/dh.h | 47 ++++++++++++++++++++++++++++++++++-------------
 1 file changed, 34 insertions(+), 13 deletions(-)

(limited to 'src')

diff --git a/src/pubkey/dh/dh.h b/src/pubkey/dh/dh.h
index 2a567fb70..5f4cb5fa1 100644
--- a/src/pubkey/dh/dh.h
+++ b/src/pubkey/dh/dh.h
@@ -11,9 +11,9 @@
 
 namespace Botan {
 
-/*************************************************
-* Diffie-Hellman Public Key                      *
-*************************************************/
+/**
+* This class represents Diffie-Hellman public keys.
+*/
 class BOTAN_DLL DH_PublicKey : public virtual DL_Scheme_PublicKey
    {
    public:
@@ -24,31 +24,52 @@ class BOTAN_DLL DH_PublicKey : public virtual DL_Scheme_PublicKey
 
       DL_Group::Format group_format() const { return DL_Group::ANSI_X9_42; }
 
+      /**
+      * Construct an uninitialized key. Use this constructor if you wish
+      * to decode an encoded key into the new instance.
+      */
       DH_PublicKey() {}
-      DH_PublicKey(const DL_Group&, const BigInt&);
+
+      /**
+      * Construct a public key with the specified parameters.
+      * @param grp the DL group to use in the key
+      * @param y the public value y
+      */
+      DH_PublicKey(const DL_Group& grp, const BigInt& y);
    private:
       void X509_load_hook();
    };
 
-/*************************************************
-* Diffie-Hellman Private Key                     *
-*************************************************/
+/**
+* This class represents Diffie-Hellman private keys.
+*/
 class BOTAN_DLL DH_PrivateKey : public DH_PublicKey,
                                 public PK_Key_Agreement_Key,
                                 public virtual DL_Scheme_PrivateKey
    {
    public:
-      SecureVector<byte> derive_key(const byte[], u32bit) const;
-      SecureVector<byte> derive_key(const DH_PublicKey&) const;
-      SecureVector<byte> derive_key(const BigInt&) const;
+      SecureVector<byte> derive_key(const byte other[], u32bit length) const;
+      SecureVector<byte> derive_key(const DH_PublicKey& other) const;
+      SecureVector<byte> derive_key(const BigInt& other) const;
 
       MemoryVector<byte> public_value() const;
 
+      /**
+      * Construct an uninitialized key. Use this constructor if you wish
+      * to decode an encoded key into the new instance.
+      */
       DH_PrivateKey() {}
-      DH_PrivateKey(RandomNumberGenerator&, const DL_Group&,
-                    const BigInt& = 0);
+
+      /**
+      * Construct a private key with predetermined value.
+      * @param rng random number generator to use
+      * @param grp the group to be used in the key
+      * @param x the key's secret value (or if zero, generate a new key)
+      */
+      DH_PrivateKey(RandomNumberGenerator& rng, const DL_Group& grp,
+                    const BigInt& x = 0);
    private:
-      void PKCS8_load_hook(RandomNumberGenerator&, bool = false);
+      void PKCS8_load_hook(RandomNumberGenerator& rng, bool = false);
       DH_Core core;
    };
 
-- 
cgit v1.2.3