From 344e0ae03bbf3ae3fb4e90eb41c2297f9dc43c6d Mon Sep 17 00:00:00 2001
From: lloyd <lloyd@randombit.net>
Date: Mon, 13 Oct 2008 18:27:40 +0000
Subject: More Doxygen comments from InSiTo

---
 src/cert/cvc/signed_obj.h | 50 ++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 43 insertions(+), 7 deletions(-)

(limited to 'src/cert/cvc')

diff --git a/src/cert/cvc/signed_obj.h b/src/cert/cvc/signed_obj.h
index 2dfc91747..b55a3d7ec 100644
--- a/src/cert/cvc/signed_obj.h
+++ b/src/cert/cvc/signed_obj.h
@@ -15,26 +15,62 @@
 
 namespace Botan {
 
-/*************************************************
-* EAC SIGNED Object                              *
-*************************************************/
+/**
+* This class represents abstract signed EAC object
+*/
 class BOTAN_DLL EAC_Signed_Object
    {
    public:
+      /**
+      * Get the TBS (to-be-signed) data in this object.
+      * @return the DER encoded TBS data of this object
+      */
       virtual SecureVector<byte> tbs_data() const = 0;
-      virtual SecureVector<byte> get_concat_sig() const = 0;  // NOTE: this is here
-      // only because abstract
-      // signature objects have
-      // not yet been introduced
+
+      /**
+      * Get the signature of this object as a concatenation, i.e. if the
+      * signature consists of multiple parts (like in the case of ECDSA)
+      * these will be concatenated.
+      * @return the signature as a concatenation of its parts
+      */
+
+      /*
+       NOTE: this is here only because abstract signature objects have
+       not yet been introduced
+      */
+      virtual SecureVector<byte> get_concat_sig() const = 0;
+
       /**
       * Get the signature algorithm identifier used to sign this object.
       * @result the signature algorithm identifier
       */
       AlgorithmIdentifier signature_algorithm() const;
 
+      /**
+      * Check the signature of this object.
+      * @param key the public key associated with this signed object
+      * @return true if the signature was created by the private key
+      * associated with this public key
+      */
       virtual bool check_signature(class Public_Key&) const = 0;
+
+      /**
+      * Write this object DER encoded into a specified pipe.
+      * @param pipe the pipe to write the encoded object to
+      * @param enc the encoding type to use
+      */
       virtual void encode(Pipe&, X509_Encoding = PEM) const = 0;
+
+      /**
+      * BER encode this object.
+      * @return the result containing the BER representation of this object.
+      */
       SecureVector<byte> BER_encode() const;
+
+      /**
+      * PEM encode this object.
+      * @return the result containing the PEM representation of this object.
+      */
       std::string PEM_encode() const;
 
       EAC_Signed_Object(SharedPtrConverter<DataSource>, const std::string&);
-- 
cgit v1.2.3