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

Scott Cantor cantor.2 at osu.edu
Fri Apr 27 15:05:39 EDT 2018


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

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

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

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

commit f65ce531589bfa244651607cb199b22c5acb33c3
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Fri Apr 27 15:05:35 2018 -0400

    Doc nits.
---
 xmltooling/security/AbstractPKIXTrustEngine.h | 2 +-
 xmltooling/security/DataSealer.h              | 2 +-
 xmltooling/security/PKIXPathValidatorParams.h | 3 +++
 xmltooling/util/CloneInputStream.h            | 4 ++--
 xmltooling/util/DirectoryWalker.h             | 1 +
 xmltooling/util/ParserPool.h                  | 2 +-
 xmltooling/util/StorageService.h              | 2 +-
 7 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/xmltooling/security/AbstractPKIXTrustEngine.h b/xmltooling/security/AbstractPKIXTrustEngine.h
index 80d77e0..0ba1cc1 100644
--- a/xmltooling/security/AbstractPKIXTrustEngine.h
+++ b/xmltooling/security/AbstractPKIXTrustEngine.h
@@ -57,7 +57,7 @@ namespace xmltooling {
          *  <li>checkRevocation attribute (off, entityOnly, fullChain)
          *  <li>policyMappingInhibit attribute (boolean)
          *  <li>anyPolicyInhibit attribute (boolean)
-         *  <li>&t;PathValidator> element (zero or more)
+         *  <li><PathValidator> element (zero or more)
          *  <li><TrustedName> element (zero or more)
          *  <li><PolicyOID> element (zero or more)
          * </ul>
diff --git a/xmltooling/security/DataSealer.h b/xmltooling/security/DataSealer.h
index de617bc..54ae614 100644
--- a/xmltooling/security/DataSealer.h
+++ b/xmltooling/security/DataSealer.h
@@ -106,7 +106,7 @@ namespace xmltooling {
         * (in length-prefixed UTF-8 format), which identifies the key used. Finally the result is encoded
         * safely for ASCII use (e.g., base64).</p>
         *
-        * @param data the data to wrap
+        * @param s the data to wrap
         * @param exp expiration time
         * @return the encoded blob
         */
diff --git a/xmltooling/security/PKIXPathValidatorParams.h b/xmltooling/security/PKIXPathValidatorParams.h
index e460e4e..f387f97 100644
--- a/xmltooling/security/PKIXPathValidatorParams.h
+++ b/xmltooling/security/PKIXPathValidatorParams.h
@@ -83,6 +83,9 @@ namespace xmltooling {
          */
         virtual const std::vector<XSECCryptoX509*>& getTrustAnchors() const=0;
 
+        /**
+         * Revocation types.
+         */
         enum revocation_t {
             REVOCATION_OFF = 0,
             REVOCATION_ENTITYONLY = 1,
diff --git a/xmltooling/util/CloneInputStream.h b/xmltooling/util/CloneInputStream.h
index 8c5d3d7..362015f 100644
--- a/xmltooling/util/CloneInputStream.h
+++ b/xmltooling/util/CloneInputStream.h
@@ -42,7 +42,7 @@ namespace xmltooling {
          * Constructor.
          *
          * @param stream a stream that we will read from
-         * @param backingFele the name of a file to write every byte we read, as we read it.
+         * @param backingFile the name of a file to write every byte we read, as we read it.
          *        we take ownership of this, arranging to delete it in our destructor.
          */
         CloneInputStream(xercesc::BinInputStream *stream, const std::string& backingFile);
@@ -56,7 +56,7 @@ namespace xmltooling {
 
     private :
         logging::Category& m_log;
-	xercesc::BinInputStream* m_input;
+        xercesc::BinInputStream* m_input;
         std::ofstream m_backingStream;
     };
 };
diff --git a/xmltooling/util/DirectoryWalker.h b/xmltooling/util/DirectoryWalker.h
index 8210b32..0cb42d6 100644
--- a/xmltooling/util/DirectoryWalker.h
+++ b/xmltooling/util/DirectoryWalker.h
@@ -51,6 +51,7 @@ namespace xmltooling {
         /**
          * Constructor.
          *
+         * @param log log category
          * @param path directory path to walk
          * @param recurse true iff nested directories should be processed
          */
diff --git a/xmltooling/util/ParserPool.h b/xmltooling/util/ParserPool.h
index 93079b3..bf6fc2c 100644
--- a/xmltooling/util/ParserPool.h
+++ b/xmltooling/util/ParserPool.h
@@ -118,7 +118,7 @@ namespace xmltooling {
          * @param pathname  path to a catalog file
          * @return true iff the catalog was successfully processed
          */
-        bool loadCatalog(const char* pathnames);
+        bool loadCatalog(const char* pathname);
 
         /**
          * Load an OASIS catalog file to map schema namespace URIs to filenames.
diff --git a/xmltooling/util/StorageService.h b/xmltooling/util/StorageService.h
index b99cb48..7cfc0da 100644
--- a/xmltooling/util/StorageService.h
+++ b/xmltooling/util/StorageService.h
@@ -61,7 +61,7 @@ namespace xmltooling {
              * Constructor.
              *
              * @param contextSize   max size of context labels in characters
-             * @param keysize       max size of keys in characters
+             * @param keySize       max size of keys in characters
              * @param stringSize    max size of string values in characters
              */
             Capabilities(unsigned int contextSize, unsigned int keySize, unsigned int stringSize);

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


More information about the commits mailing list