Doc fixes.
authorcantor <cantor@cb58f699-b61c-0410-a6fe-9272a202ed29>
Fri, 9 Nov 2007 06:23:30 +0000 (06:23 +0000)
committercantor <cantor@cb58f699-b61c-0410-a6fe-9272a202ed29>
Fri, 9 Nov 2007 06:23:30 +0000 (06:23 +0000)
git-svn-id: https://svn.middleware.georgetown.edu/cpp-sp/trunk@2594 cb58f699-b61c-0410-a6fe-9272a202ed29

shibsp/ServiceProvider.h
shibsp/attribute/NameIDAttribute.h
shibsp/handler/AbstractHandler.h

index ecb86fb..f7b2ba1 100644 (file)
@@ -131,7 +131,7 @@ namespace shibsp {
          * Returns a RequestMapper instance.
          * 
          * @param required  true iff an exception should be thrown if no RequestMapper is available
-         * @param a RequestMapper
+         * @return  a RequestMapper
          */
         virtual RequestMapper* getRequestMapper(bool required=true) const=0;
         
index d508ef2..bd292ce 100644 (file)
@@ -45,7 +45,8 @@ namespace shibsp {
         /**
          * Constructor.
          * 
-         * @param ids   array with primary identifier in first position, followed by any aliases
+         * @param ids       array with primary identifier in first position, followed by any aliases
+         * @param formatter template for serialization of tuple
          */
         NameIDAttribute(const std::vector<std::string>& ids, const char* formatter=DEFAULT_NAMEID_FORMATTER)
             : Attribute(ids), m_formatter(formatter) {
index e88ab33..4c0cc6f 100644 (file)
@@ -54,7 +54,8 @@ namespace shibsp {
         /**
          * Constructor
          * 
-         * @param e         DOM element to load as property set. 
+         * @param e         DOM element to load as property set.
+         * @param log       logging category to use
          * @param filter    optional filter controls what child elements to include as nested PropertySets
          * @param remapper  optional map of property rename rules for legacy property support
          */
@@ -83,9 +84,10 @@ namespace shibsp {
         /**
          * Prepares Status information in a SAML 2.0 response.
          * 
-         * @param response  SAML 2.0 response message
+         * @param response  SAML 2.0 response message
          * @param code      SAML status code
-         * @param ex        optional message to pass back
+         * @param subcode   optional SAML substatus code
+         * @param msg       optional message to pass back
          */
         void fillStatus(
             opensaml::saml2p::StatusResponseType& response, const XMLCh* code, const XMLCh* subcode=NULL, const char* msg=NULL