Merged marshalling/unmarshalling methods into core interface.

[shibboleth/cpp-xmltooling.git] / xmltooling / signature / SigningContext.h

diff --git a/xmltooling/signature/SigningContext.h b/xmltooling/signature/SigningContext.h
index 72648d6..2e6d249 100644 (file)
--- a/xmltooling/signature/SigningContext.h
+++ b/xmltooling/signature/SigningContext.h
@@ -47,7 +47,9 @@ namespace xmltooling {
          * appropriate signature transforms, references, etc.\r
          * This method MAY attach ds:KeyInfo information, or a set of X.509\r
          * certificates can be returned from the SigningContext::getX509Certificates()\r
-         * method instead.   \r
+         * method instead.\r
+         * \r
+         * @param sig   native signature interface\r
          */\r
         virtual void createSignature(DSIGSignature* sig) const=0;\r
         \r
@@ -56,6 +58,8 @@ namespace xmltooling {
          * the ds:KeyInfo element in a ds:X509Data chain.\r
          * The certificate corresponding to the signing key SHOULD be\r
          * first, followed by any additional intermediates to append. \r
+         * \r
+         * @return  an immutable collection of certificates to embed\r
          */\r
         virtual const std::vector<XSECCryptoX509*>& getX509Certificates() const=0;\r
         \r
@@ -63,6 +67,8 @@ namespace xmltooling {
          * Gets the signing key to use.\r
          * Must be compatible with the intended signature algorithm. Ownership of the key\r
          * MUST be transferred to the caller.\r
+         * \r
+         * @return  pointer to a signing key, will be freed by caller\r
          */\r
         virtual XSECCryptoKey* getSigningKey() const=0;\r
         \r