Fix some Doxygen tags related to files and namespaces.

[shibboleth/cpp-opensaml.git] / saml / SAMLConfig.h

diff --git a/saml/SAMLConfig.h b/saml/SAMLConfig.h
index c8a00d6..0fd432d 100644 (file)
--- a/saml/SAMLConfig.h
+++ b/saml/SAMLConfig.h
@@ -15,7 +15,7 @@
  */\r
 \r
 /**\r
- * @file SAMLConfig.h\r
+ * @file saml/SAMLConfig.h\r
  * \r
  * Library configuration \r
  */\r
@@ -24,7 +24,15 @@
 #define __saml_config_h__\r
 \r
 #include <saml/base.h>\r
+#include <xmltooling/unicode.h>\r
+#include <xmltooling/XMLToolingConfig.h>\r
 \r
+#include <string>\r
+\r
+/**\r
+ * @namespace opensaml\r
+ * Common classes for OpenSAML library\r
+ */\r
 namespace opensaml {\r
 \r
     /**\r
@@ -60,6 +68,30 @@ namespace opensaml {
          * before terminating itself\r
          */\r
         virtual void term()=0;\r
+        \r
+        /**\r
+         * Generate random information using the underlying security library\r
+         * \r
+         * @param buf   buffer for the information\r
+         * @param len   number of bytes to write into buffer\r
+         */\r
+        virtual void generateRandomBytes(void* buf, unsigned int len)=0;\r
+\r
+        /**\r
+         * Generate random information using the underlying security library\r
+         * \r
+         * @param buf   string buffer for the information\r
+         * @param len   number of bytes to write into buffer\r
+         */\r
+        virtual void generateRandomBytes(std::string& buf, unsigned int len)=0;\r
+\r
+        /**\r
+         * Generate a valid XML identifier of the form _X{32} where X is a\r
+         * random hex character. The caller is responsible for freeing the result.\r
+         * \r
+         * @return a valid null-terminated XML ID\r
+         */\r
+        virtual XMLCh* generateIdentifier()=0;\r
 \r
     protected:\r
         SAMLConfig() {}\r