[cpp-opensaml] branch master updated: Doc nits.

Scott Cantor cantor.2 at osu.edu
Fri Apr 27 15:22:55 EDT 2018


This is an automated email from the git hooks/post-receive script.

scantor pushed a commit to branch master
in repository cpp-opensaml.

View the commit online:
http://git.shibboleth.net/view/?p=cpp-opensaml.git;a=commit;h=c5f0565f4ae5b764873df5ff91531636d3d1df73

The following commit(s) were added to refs/heads/master by this push:
       new  c5f0565   Doc nits.
c5f0565 is described below

commit c5f0565f4ae5b764873df5ff91531636d3d1df73
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Fri Apr 27 15:22:51 2018 -0400

    Doc nits.
---
 saml/SAMLConfig.h                                | 2 +-
 saml/binding/SAMLArtifact.h                      | 5 +++++
 saml/saml2/metadata/MetadataCredentialCriteria.h | 5 +++++
 3 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/saml/SAMLConfig.h b/saml/SAMLConfig.h
index af66e1b..2819621 100644
--- a/saml/SAMLConfig.h
+++ b/saml/SAMLConfig.h
@@ -158,7 +158,7 @@ namespace opensaml {
         /**
          * Returns the appropriate contact to use for the role.
          *
-         * @param entity    the role to search
+         * @param role    the role to search
          * @return  a contact to use, or nullptr
          */
         virtual const saml2md::ContactPerson* getContactPerson(const saml2md::RoleDescriptor& role) const=0;
diff --git a/saml/binding/SAMLArtifact.h b/saml/binding/SAMLArtifact.h
index 16e1b2d..b6d61d5 100644
--- a/saml/binding/SAMLArtifact.h
+++ b/saml/binding/SAMLArtifact.h
@@ -141,6 +141,11 @@ namespace opensaml {
          */        
         SAMLArtifact(const char* s);
 
+        /**
+         * Copy constructor.
+         *
+         * @param src copy source
+         */
         SAMLArtifact(const SAMLArtifact& src);
         
         /** Raw binary data that makes up an artifact. */
diff --git a/saml/saml2/metadata/MetadataCredentialCriteria.h b/saml/saml2/metadata/MetadataCredentialCriteria.h
index e4bace2..9661d6c 100644
--- a/saml/saml2/metadata/MetadataCredentialCriteria.h
+++ b/saml/saml2/metadata/MetadataCredentialCriteria.h
@@ -57,6 +57,11 @@ namespace opensaml {
                 return m_role;
             }
 
+            /**
+             * Get whether the candidate credential matches the criteria.
+             *
+             * @param credential candidate
+             */
             bool matches(const xmltooling::Credential& credential) const;
 
         private:

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the commits mailing list