From f59cacc01b042210865a8cb9b766c646dce23629 Mon Sep 17 00:00:00 2001
From: lloyd <lloyd@randombit.net>
Date: Mon, 13 Oct 2008 03:15:59 +0000
Subject: More Doxygen comments from InSiTo

---
 src/filters/buf_filt.h         |  8 +++++---
 src/modes/modebase/modebase.h  |  7 ++++---
 src/pubkey/keypair/keypair.h   | 20 +++++++++++++++++---
 src/pubkey/pk_lookup/pk_algs.h | 14 +++++++++++---
 4 files changed, 37 insertions(+), 12 deletions(-)

(limited to 'src')

diff --git a/src/filters/buf_filt.h b/src/filters/buf_filt.h
index 290c7eb75..fdb504518 100644
--- a/src/filters/buf_filt.h
+++ b/src/filters/buf_filt.h
@@ -10,9 +10,11 @@
 
 namespace Botan {
 
-/*************************************************
-* Buffering Filter                               *
-*************************************************/
+/**
+* Buffering_Filter: This class represents filters for operations that
+* maintain an internal state.
+*/
+
 class BOTAN_DLL Buffering_Filter : public Filter
    {
    public:
diff --git a/src/modes/modebase/modebase.h b/src/modes/modebase/modebase.h
index 90ab277b2..620a5c618 100644
--- a/src/modes/modebase/modebase.h
+++ b/src/modes/modebase/modebase.h
@@ -10,9 +10,9 @@
 
 namespace Botan {
 
-/*************************************************
-* Block Cipher Mode                              *
-*************************************************/
+/**
+* This class represents an abstract block cipher mode
+*/
 class BOTAN_DLL BlockCipherMode : public Keyed_Filter
    {
    public:
@@ -20,6 +20,7 @@ class BOTAN_DLL BlockCipherMode : public Keyed_Filter
 
       BlockCipherMode(const std::string&, const std::string&,
                       u32bit, u32bit = 0, u32bit = 1);
+
       virtual ~BlockCipherMode() { delete cipher; }
    protected:
       void set_iv(const InitializationVector&);
diff --git a/src/pubkey/keypair/keypair.h b/src/pubkey/keypair/keypair.h
index 4013ad328..ead6ae68c 100644
--- a/src/pubkey/keypair/keypair.h
+++ b/src/pubkey/keypair/keypair.h
@@ -12,10 +12,24 @@ namespace Botan {
 
 namespace KeyPair {
 
-/*************************************************
-* Check key pair consistency                     *
-*************************************************/
+/**
+* Tests whether the specified encryptor and decryptor are related to each other,
+* i.e. whether encrypting with the encryptor and consecutive decryption leads to
+* the original plaintext.
+* @param enc the encryptor to test
+* @param dec the decryptor to test
+* @throw Self_Test_Failure if the arguments are not related to each other
+*/
 BOTAN_DLL void check_key(RandomNumberGenerator&, PK_Encryptor*, PK_Decryptor*);
+
+/**
+* Tests whether the specified signer and verifier are related to each other,
+* i.e. whether a signature created with the signer and can be
+* successfully verified with the verifier.
+* @param sig the signer to test
+* @param ver the verifier to test
+* @throw Self_Test_Failure if the arguments are not related to each other
+*/
 BOTAN_DLL void check_key(RandomNumberGenerator&, PK_Signer*, PK_Verifier*);
 
 }
diff --git a/src/pubkey/pk_lookup/pk_algs.h b/src/pubkey/pk_lookup/pk_algs.h
index a8fa5f176..2bb9a546e 100644
--- a/src/pubkey/pk_lookup/pk_algs.h
+++ b/src/pubkey/pk_lookup/pk_algs.h
@@ -11,10 +11,18 @@
 
 namespace Botan {
 
-/*************************************************
-* Get an PK key object                           *
-*************************************************/
+/**
+* Get an empty public key object.
+* @param name the name of the desired public key algorithm
+* @return the public key object
+*/
 BOTAN_DLL Public_Key*  get_public_key(const std::string&);
+
+/**
+* Get an empty private key object.
+* @param name the name of the desired public key algorithm
+* @return the private key object
+*/
 BOTAN_DLL Private_Key* get_private_key(const std::string&);
 
 }
-- 
cgit v1.2.3