Merge "Remove the memory leak on osp-security-service" into tizen_2.2

[platform/framework/native/appfw.git] / inc / FSecCertX509CertificatePath.h

diff --git a/inc/FSecCertX509CertificatePath.h b/inc/FSecCertX509CertificatePath.h
index 6b3cf8b..d025738 100644 (file)
--- a/inc/FSecCertX509CertificatePath.h
+++ b/inc/FSecCertX509CertificatePath.h
@@ -35,11 +35,11 @@ class _CertMgrSvcProxy;
 
 /**
  *     @class          X509CertificatePath
- *     @brief          This class provides the certificate path.
+ *     @brief          This class provides methods for the certificate path.
  *
  *     @since          2.0
  *
- * The %X509CertificatePath class provides the certificate path. @n
+ * The %X509CertificatePath class provides methods for the certificate path. @n
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/certificate_namespace.htm">Certificates</a>.
  */
@@ -86,8 +86,9 @@ public:
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_INVALID_ARG                   The specified @c certificate or the certificate data is invalid.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
-        *      @exception      E_SYSTEM                                A system error has occurred. @n
-        *                                                                              The certificate link list operation has failed.
+        *      @exception      E_SYSTEM                                Either of the following conditions has occurred:
+        *                                                                              - A system error has occurred.
+        *                                                                              - The certificate link list operation has failed.
         */
        virtual result AddCertificate(const Tizen::Security::Cert::ICertificate& certificate);
 
@@ -98,9 +99,10 @@ public:
         *
         *      @return         The result of the certificate path validation
         *      @exception      E_SUCCESS                               The method is successful.
-        *      @exception      E_SYSTEM                                A system error has occurred.
-        *                                                                              The certificate link list operation has failed.
-        * @remarks        The specific error code can be accessed using the GetLastResult() method.
+        *      @exception      E_SYSTEM                                Either of the following conditions has occurred:
+        *                                                                              - A system error has occurred.
+        *                                                                              - The certificate link list operation has failed.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Security::Cert::ValidationResult Validate(void);
 
@@ -114,9 +116,10 @@ public:
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
         *      @exception      E_INVALID_ARG                   The specified input parameter is invalid.
-        *      @exception      E_SYSTEM                                A system error has occurred. @n
-        *                                                                              The certificate link list operation has failed.
-        * @remarks        The specific error code can be accessed using the GetLastResult() method.
+        *      @exception      E_SYSTEM                                Either of the following conditions has occurred:
+        *                                                                              - A system error has occurred.
+        *                                                                              - The certificate link list operation has failed.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Security::Cert::ValidationResult Validate(const Tizen::Security::Cert::ICertificate& trustAnchor);
 
@@ -128,8 +131,9 @@ public:
         *      @return         The length of the certificate path, @n
         *                              else @c -1 if an error occurs
         *      @exception      E_SUCCESS                               The method is successful.
-        *      @exception      E_SYSTEM                                A system error has occurred. @n
-        *                                                                              The certificate link list operation has failed.
+        *      @exception      E_SYSTEM                                Either of the following conditions has occurred:
+        *                                                                              - A system error has occurred.
+        *                                                                              - The certificate link list operation has failed.
         */
        virtual int GetLength(void) const;
 
@@ -140,15 +144,16 @@ public:
         *
         *      @return         A pointer to the ICertificate interface, @n
         *                              else @c null if an error occurs
-        *  @param[in]  nth                                             The nth certificate in the certificate path (starts from @c 0)
+        *      @param[in]      nth                                             The nth certificate in the certificate path (starts from @c 0)
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
         *      @exception      E_INVALID_ARG                   The value of the specified @c nth is out of the valid range. @n
         *                                                                              It must be less than the value retrieved by the GetLength() method.
         *      @exception      E_OBJ_NOT_FOUND                 The certificate is not found.
-        *      @exception      E_SYSTEM                                A system error has occurred. @n
-        *                                                                              The certificate link list operation has failed.
-        * @remarks        The specific error code can be accessed using the GetLastResult() method.
+        *      @exception      E_SYSTEM                                Either of the following conditions has occurred:
+        *                                                                              - A system error has occurred.
+        *                                                                              - The certificate link list operation has failed.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Security::Cert::ICertificate* GetCertificateN(int nth) const;
 
@@ -158,14 +163,15 @@ public:
         *      @since                  2.0
         *
         *      @return         The root certificate, @n
-        *                                      else @c null if an error occurs
+        *                              else @c null if an error occurs
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
         *      @exception      E_OBJ_NOT_FOUND                 The certificate is not found.
-        *      @exception      E_SYSTEM                                A system error has occurred. @n
-        *                                                                              The certificate link list operation or
-        *                                                                              the Tizen::Base::ByteBuffer operation has failed.
-        * @remarks        The specific error code can be accessed using the GetLastResult() method.
+        *      @exception      E_SYSTEM                                Either of the following conditions has occurred:
+        *                                                                              - A system error has occurred.
+        *                                                                              - The certificate link list operation has failed.
+        *                                                                              - The Tizen::Base::ByteBuffer operation has failed.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Security::Cert::ICertificate* GetTrustAnchorN(void) const;