Add some missing comments.
authorScott Cantor <cantor.2@osu.edu>
Thu, 26 Apr 2007 20:25:47 +0000 (20:25 +0000)
committerScott Cantor <cantor.2@osu.edu>
Thu, 26 Apr 2007 20:25:47 +0000 (20:25 +0000)
xmltooling/encryption/Decrypter.h
xmltooling/encryption/Encrypter.h

index 4ae0885..780d1a0 100644 (file)
@@ -47,7 +47,7 @@ namespace xmlencryption {
          * 
          * @param credResolver  locked credential resolver to supply decryption keys
          * @param criteria      optional external criteria to use with resolver
-         * @param EKresolver    locates an EncryptedKey pertaining to the EncryptedData
+         * @param EKResolver    locates an EncryptedKey pertaining to the EncryptedData
          */
         Decrypter(
             const xmltooling::CredentialResolver* credResolver=NULL,
@@ -61,7 +61,7 @@ namespace xmlencryption {
         /**
          * Replace the current EncryptedKeyResolver interface, if any, with a new one.
          * 
-         * @param EKresolver  the EncryptedKeyResolver to attach 
+         * @param EKResolver  the EncryptedKeyResolver to attach 
          */
         void setEncryptedKeyResolver(const EncryptedKeyResolver* EKResolver) {
             m_EKResolver=EKResolver;
index 86fe642..1c85762 100644 (file)
@@ -88,10 +88,19 @@ namespace xmlencryption {
 
             ~EncryptionParams() {}
 
+            /** Data encryption algorithm. */
             const XMLCh* m_algorithm;
+            
+            /** Buffer containing encryption key. */
             const unsigned char* m_keyBuffer;
+
+            /** Size of buffer. */
             unsigned int m_keyBufferSize;
+
+            /** Credential containing the encryption key. */
             const xmltooling::Credential* m_credential;
+
+            /** Flag limiting the size of the encrypted XML representation. */
             bool m_compact;
         };
         
@@ -115,8 +124,13 @@ namespace xmlencryption {
         
             ~KeyEncryptionParams() {}
 
+            /** Credential containing key encryption key. */
             const xmltooling::Credential& m_credential;
+
+            /** Key transport or wrapping algorithm. */
             const XMLCh* m_algorithm;
+
+            /** Name of recipient that owns the key encryption key. */
             const XMLCh* m_recipient;
         };