cvs commit: xml-security/c/src/enc XSECCryptoBase64.hpp XSECCryptoException.hpp XSECCryptoHash.hpp XSECCryptoKey.hpp

[bl...@apache.org]

blautenb    2003/02/23 00:41:13

  Modified:    c/src/enc XSECCryptoBase64.hpp XSECCryptoException.hpp
                        XSECCryptoHash.hpp XSECCryptoKey.hpp
  Log:
  Update Doxy Docs
  
  Revision  Changes    Path
  1.3       +4 -6      xml-security/c/src/enc/XSECCryptoBase64.hpp
  
  Index: XSECCryptoBase64.hpp
  ===================================================================
  RCS file: /home/cvs/xml-security/c/src/enc/XSECCryptoBase64.hpp,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- XSECCryptoBase64.hpp	9 Feb 2003 11:13:49 -0000	1.2
  +++ XSECCryptoBase64.hpp	23 Feb 2003 08:41:13 -0000	1.3
  @@ -64,9 +64,7 @@
    *
    * Author(s): Berin Lautenbach
    *
  - * $ID$
  - *
  - * $LOG$
  + * $Id$
    *
    */
   
  @@ -81,10 +79,10 @@
    /*\@{*/
   
   /**
  - * \brief Base64 encode/decode handler.
  + * \brief Base64 encode/decode handler interface class.
    *
  - * <p>The XSEC library will use this class for translating bytes to/from
  - * base64 encoding.</p>
  + * <p>The XSEC library will use implementations of this interface 
  + * for translating bytes to/from base64 encoding.</p>
    *
    * <p>There are many places where XML DSIG uses Base64 encoding for 
    * embedding data in the <Signature> structure.  In some cases this object
  
  
  
  1.3       +6 -7      xml-security/c/src/enc/XSECCryptoException.hpp
  
  Index: XSECCryptoException.hpp
  ===================================================================
  RCS file: /home/cvs/xml-security/c/src/enc/XSECCryptoException.hpp,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- XSECCryptoException.hpp	9 Feb 2003 11:13:49 -0000	1.2
  +++ XSECCryptoException.hpp	23 Feb 2003 08:41:13 -0000	1.3
  @@ -64,9 +64,7 @@
    *
    * Author(s): Berin Lautenbach
    *
  - * $ID$
  - *
  - * $LOG$
  + * $Id$
    *
    */
   #ifndef XSECCRYPTOEXCEPTION_INCLUDE
  @@ -97,12 +95,13 @@
   /**
    * \brief Exception class used by the cryptographic modules
    *
  - * <p>This exception class should be used by the Cryptographic providers
  - * for reporting errors.</p>
  + * This exception class should be used by the Cryptographic providers
  + * for reporting errors. It can be used directly or by classes which
  + * inherit from it.
    *
  - * <p>It's a fairly standard exception class, with a type parameter
  + * It's a fairly standard exception class, with a type parameter
    * (and associated enumerated type) and a string that can be used to
  - * provide more information to the caller.</p>
  + * provide more information to the caller.
    */
   
   class DSIG_EXPORT XSECCryptoException {
  
  
  
  1.3       +6 -0      xml-security/c/src/enc/XSECCryptoHash.hpp
  
  Index: XSECCryptoHash.hpp
  ===================================================================
  RCS file: /home/cvs/xml-security/c/src/enc/XSECCryptoHash.hpp,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- XSECCryptoHash.hpp	9 Feb 2003 11:13:49 -0000	1.2
  +++ XSECCryptoHash.hpp	23 Feb 2003 08:41:13 -0000	1.3
  @@ -78,6 +78,7 @@
   
   /**
    * @ingroup crypto
  + * @{
    */
   
   /**
  @@ -177,6 +178,7 @@
   	//@}
   
   	/** @name HMAC Functions */
  +	//@{
   	
   	/**
   	 *\brief
  @@ -193,6 +195,10 @@
   
   	virtual void		setKey(XSECCryptoKey * key) = 0;
   
  +	//@}
  +
   };
  +
  +/** @} */
   
   #endif /* XSECCRYPTOHASH_INCLUDE */
  
  
  
  1.3       +58 -4     xml-security/c/src/enc/XSECCryptoKey.hpp
  
  Index: XSECCryptoKey.hpp
  ===================================================================
  RCS file: /home/cvs/xml-security/c/src/enc/XSECCryptoKey.hpp,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- XSECCryptoKey.hpp	9 Feb 2003 11:13:49 -0000	1.2
  +++ XSECCryptoKey.hpp	23 Feb 2003 08:41:13 -0000	1.3
  @@ -66,21 +66,43 @@
    *
    * Author(s): Berin Lautenbach
    *
  - * $ID$
  - *
  - * $LOG$
  + * $Id$
    *
    */
   
  +
  +
   #ifndef XSECCRYPTOKEY_INCLUDE
   #define XSECCRYPTOKEY_INCLUDE
   
   #include <xsec/framework/XSECDefs.hpp>
   
  +/**
  + * \ingroup crypto
  + * @{
  + */
  +
  +/**
  + * \brief Base interface class for key material.
  + *
  + * All keys used for signing and encrypting are derived from this
  + * base interface class.  There are no methods for performing
  + * cryptographic functions, as this is a base class used to allow
  + * the library to pass key material to various objects without
  + * knowing how to directly use it.
  + */
  +
   class DSIG_EXPORT XSECCryptoKey {
   
   public :
   
  +	/**
  +	 * \brief Key types understood by the library
  +	 *
  +	 * This type defines the list of key types that the library
  +	 * understands.
  +	 */
  +
   	enum KeyType {
   
   		KEY_NONE,
  @@ -94,15 +116,47 @@
   	
   	};
   
  -	// Constructors/Destructors
  +
  +	/** @name Constructors and Destructors */
  +	//@{
   	
  +	/**
  +	 * \brief Constructor
  +	 **/
  +
   	XSECCryptoKey() {};
  +
  +	/**
  +	 * \brief Destructor 
  +	 */
  +
   	virtual ~XSECCryptoKey() {};
   
  +	//@}
  +
  +	/** @name Interface classes */
  +	//@{
  +
  +	/**
  +	 * \brief Returns the type of this key.
  +	 */
  +
   	virtual KeyType getKeyType() {return KEY_NONE;}
   
  +	/**
  +	 * \brief Clone the key
  +	 *
  +	 * All keys need to be able to copy themselves and return
  +	 * a pointer to the copy.  This allows the library to 
  +	 * duplicate keys.
  +	 */
  +
   	virtual XSECCryptoKey * clone() = 0;
   
  +  //@}
  +
   };
  +
  +/** @} */
   
   #endif /* XSECCRYPTOKEY_INCLUDE */