Fix comments, add a missing const.
authorScott Cantor <cantor.2@osu.edu>
Thu, 26 Apr 2007 21:18:22 +0000 (21:18 +0000)
committerScott Cantor <cantor.2@osu.edu>
Thu, 26 Apr 2007 21:18:22 +0000 (21:18 +0000)
14 files changed:
saml/binding/SOAPClient.h
saml/encryption/EncryptedKeyResolver.h
saml/saml1/binding/SAMLArtifactType0001.h
saml/saml1/binding/SAMLArtifactType0002.h
saml/saml2/binding/SAML2Artifact.h
saml/saml2/binding/SAML2ArtifactType0004.h
saml/saml2/core/Assertions.h
saml/saml2/metadata/AbstractMetadataProvider.h
saml/saml2/metadata/EndpointManager.h
saml/saml2/metadata/MetadataCredentialContext.h
saml/saml2/metadata/MetadataCredentialCriteria.h
saml/saml2/metadata/impl/AbstractMetadataProvider.cpp
saml/util/CGIParser.h
samltest/encryption/.gitignore [new file with mode: 0644]

index 337b4fa..aa2a995 100644 (file)
@@ -39,7 +39,6 @@ namespace opensaml {
          * Creates a SOAP client instance with a particular SecurityPolicy.
          * 
          * @param policy        reference to SecurityPolicy to apply
-         * @param validating    controls schema validation
          */
         SOAPClient(SecurityPolicy& policy)
             : soap11::SOAPClient(policy.getValidating()), m_policy(policy), m_force(true), m_peer(NULL), m_criteria(NULL) {
index 8063c1c..db5f501 100644 (file)
@@ -41,6 +41,11 @@ namespace opensaml {
     class SAML_API EncryptedKeyResolver : public xmlencryption::EncryptedKeyResolver
     {
     public:
+        /**
+         * Constructor.
+         * 
+         * @param ref   reference to encrypted element
+         */
         EncryptedKeyResolver(const saml2::EncryptedElementType& ref) : m_ref(ref) {
         }
         
@@ -49,6 +54,7 @@ namespace opensaml {
         const xmlencryption::EncryptedKey* resolveKey(const xmlencryption::EncryptedData& encryptedData, const XMLCh* recipient=NULL) const;
      
     protected:
+        /** Reference to encrypted element. */
         const saml2::EncryptedElementType& m_ref;
     };
 
index 81ecf6e..c3b1869 100644 (file)
@@ -88,6 +88,11 @@ namespace opensaml {
             static const unsigned int HANDLE_LENGTH;
     
         protected:
+            /**
+             * Copy constructor.
+             * 
+             * @param src   object to copy
+             */
             SAMLArtifactType0001(const SAMLArtifactType0001& src) : SAMLArtifact(src) {}
         };
         
index 54388c0..66d7f68 100644 (file)
@@ -75,6 +75,11 @@ namespace opensaml {
             static const unsigned int HANDLE_LENGTH;
     
         protected:
+            /**
+             * Copy constructor.
+             * 
+             * @param src   object to copy
+             */
             SAMLArtifactType0002(const SAMLArtifactType0002& src) : SAMLArtifact(src) {}
         };
         
index e368085..05e7e3c 100644 (file)
@@ -50,8 +50,18 @@ namespace opensaml {
         protected:
             SAML2Artifact() {}
 
+            /**
+             * Constructor.
+             * 
+             * @param s raw artifact string
+             */
             SAML2Artifact(const char* s) : SAMLArtifact(s) {}
     
+            /**
+             * Copy constructor.
+             * 
+             * @param src   object to copy
+             */
             SAML2Artifact(const SAML2Artifact& src) : SAMLArtifact(src) {}
         };
         
index df48441..193e04b 100644 (file)
@@ -90,6 +90,11 @@ namespace opensaml {
             static const unsigned int HANDLE_LENGTH;
     
         protected:
+            /**
+             * Copy constructor.
+             * 
+             * @param src   object to copy
+             */
             SAML2ArtifactType0004(const SAML2ArtifactType0004& src) : SAML2Artifact(src) {}
         };
         
index a5a7fb7..20c4503 100644 (file)
@@ -97,6 +97,7 @@ namespace opensaml {
             /**
              * Encrypts an object to multiple recipients using this object as a container.
              * 
+             * @param xmlObject     object to encrypt
              * @param recipients    pairs containing a locked MetadataProvider to supply encryption keys,
              *                      and a metadata-based CredentialCriteria to use
              * @param compact       true iff compact KeyInfo should be used
index c905e59..09d7134 100644 (file)
@@ -61,7 +61,7 @@ namespace opensaml {
         public:
             virtual ~AbstractMetadataProvider();
             
-            void emitChangeEvent();
+            void emitChangeEvent() const;
             const EntityDescriptor* getEntityDescriptor(const char* id, bool requireValidMetadata=true) const;
             const EntityDescriptor* getEntityDescriptor(const SAMLArtifact* artifact) const;
             const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const;
index 0bcf183..4dba88c 100644 (file)
@@ -37,6 +37,7 @@ namespace opensaml {
         class EndpointManager
         {
         protected:
+            /** Reference to endpoint array. */
             typename const std::vector<_Tx*>& m_endpoints;
             
         public:
index 8ffc950..65ca20e 100644 (file)
@@ -35,7 +35,7 @@ namespace opensaml {
         class SAML_API MetadataCredentialContext : public xmltooling::KeyInfoCredentialContext
         {
         public:
-            /*
+            /**
              * Constructor.
              *
              * @param descriptor    source of metadata-supplied credential
index 7f8d77b..f23be27 100644 (file)
@@ -36,7 +36,7 @@ namespace opensaml {
         class SAML_API MetadataCredentialCriteria : public xmltooling::CredentialCriteria
         {
         public:
-            /*
+            /**
              * Constructor.
              *
              * @param role      source of metadata-supplied credentials
index e8c7b96..042e962 100644 (file)
@@ -61,7 +61,7 @@ AbstractMetadataProvider::~AbstractMetadataProvider()
     delete m_resolver;
 }
 
-void AbstractMetadataProvider::emitChangeEvent()
+void AbstractMetadataProvider::emitChangeEvent() const
 {
     for (credmap_t::iterator c = m_credentialMap.begin(); c!=m_credentialMap.end(); ++c)
         for_each(c->second.begin(), c->second.end(), xmltooling::cleanup<Credential>());
index 5288b1a..e1980fa 100644 (file)
@@ -43,6 +43,7 @@ namespace opensaml {
 
         ~CGIParser();
 
+        /** Alias for multimap iterator. */
         typedef std::multimap<std::string,char*>::const_iterator walker;
         
         /**
diff --git a/samltest/encryption/.gitignore b/samltest/encryption/.gitignore
new file mode 100644 (file)
index 0000000..e16b497
--- /dev/null
@@ -0,0 +1 @@
+/*.cpp