summaryrefslogtreecommitdiff
path: root/cpp/include/IceSSL/UWP.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpp/include/IceSSL/UWP.h')
-rw-r--r--cpp/include/IceSSL/UWP.h55
1 files changed, 32 insertions, 23 deletions
diff --git a/cpp/include/IceSSL/UWP.h b/cpp/include/IceSSL/UWP.h
index e131ade6c5b..349323e43b9 100644
--- a/cpp/include/IceSSL/UWP.h
+++ b/cpp/include/IceSSL/UWP.h
@@ -21,33 +21,42 @@ namespace UWP
class Certificate;
ICE_DEFINE_PTR(CertificatePtr, Certificate);
+/**
+ * This convenience class is a wrapper around a native certificate.
+ * \headerfile IceSSL/IceSSL.h
+ */
class ICESSL_API Certificate : public virtual IceSSL::Certificate
{
public:
- //
- // Construct a certificate using a native certificate.
- //
- static CertificatePtr create(Windows::Security::Cryptography::Certificates::Certificate^);
-
- //
- // Load the certificate from a file. The certificate must use the
- // PEM encoding format. Raises CertificateReadException if the
- // file cannot be read.
- //
- static CertificatePtr load(const std::string&);
-
- //
- // Decode a certificate from a string that uses the PEM encoding
- // format. Raises CertificateEncodingException if an error
- // occurs.
- //
- static CertificatePtr decode(const std::string&);
-
- //
- // Retrieve the native X509 certificate value wrapped by this
- // object.
- //
+ /**
+ * Constructs a certificate using a native certificate.
+ * @param cert The native certificate.
+ * @return The new certificate instance.
+ */
+ static CertificatePtr create(Windows::Security::Cryptography::Certificates::Certificate^ cert);
+
+ /**
+ * Loads the certificate from a file. The certificate must use the
+ * PEM encoding format.
+ * @param file The certificate file.
+ * @return The new certificate instance.
+ * @throws CertificateReadException if the file cannot be read.
+ */
+ static CertificatePtr load(const std::string& file);
+
+ /**
+ * Decodes a certificate from a string that uses the PEM encoding format.
+ * @param str A string containing the encoded certificate.
+ * @return The new certificate instance.
+ * @throws CertificateEncodingException if an error occurs.
+ */
+ static CertificatePtr decode(const std::string& str);
+
+ /**
+ * Obtains the native X509 certificate value wrapped by this object.
+ * @return The native certificate.
+ */
virtual Windows::Security::Cryptography::Certificates::Certificate^ getCert() const = 0;
};