From: Minkyoung Kang Date: Thu, 27 Jun 2013 05:14:39 +0000 (+0900) Subject: update header for Doxygen X-Git-Tag: submit/tizen_2.2/20130714.152805~58 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=95698d1b5f824a898e2e7485ee258937c700c350;p=framework%2Fosp%2Fappfw.git update header for Doxygen Change-Id: Ice72e5b61f78fbe2fb063d98d8727ca96866d720 --- diff --git a/inc/FSecCertICertificatePath.h b/inc/FSecCertICertificatePath.h index fa818f9..2905db7 100644 --- a/inc/FSecCertICertificatePath.h +++ b/inc/FSecCertICertificatePath.h @@ -296,7 +296,7 @@ public: * @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 GetLength(). + * 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 list is empty. diff --git a/inc/FSecCertICertificateStore.h b/inc/FSecCertICertificateStore.h index 087f84c..897ffe0 100644 --- a/inc/FSecCertICertificateStore.h +++ b/inc/FSecCertICertificateStore.h @@ -115,7 +115,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] certificateType The type of the Certificate (that is, ROOT_CA, OPERATOR_DOMAIN, or TRUSTED_THIRD_PARTY_DOMAIN) + * @param[in] certificateType The type of the Certificate (that is, @c ROOT_CA, @c OPERATOR_DOMAIN, or @c TRUSTED_THIRD_PARTY_DOMAIN) * @param[in] certificate A reference to the certificate to insert * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -133,7 +133,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] certificateType The type of the Certificate (that is, ROOT_CA, OPERATOR_DOMAIN, or TRUSTED_THIRD_PARTY_DOMAIN) + * @param[in] certificateType The type of the Certificate (that is, @c ROOT_CA, @c OPERATOR_DOMAIN, or @c TRUSTED_THIRD_PARTY_DOMAIN) * @param[in] oldCert A reference to the old certificate * @param[in] newCert A reference to the new certificate * @exception E_SUCCESS The method is successful. @@ -153,7 +153,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] certificateType The type of the Certificate (that is, ROOT_CA, OPERATOR_DOMAIN, or TRUSTED_THIRD_PARTY_DOMAIN) + * @param[in] certificateType The type of the Certificate (that is, @c ROOT_CA, @c OPERATOR_DOMAIN, or @c TRUSTED_THIRD_PARTY_DOMAIN) * @param[in] certificate A reference to the certificate to remove * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. diff --git a/inc/FSecCertX509CertificatePath.h b/inc/FSecCertX509CertificatePath.h index 4d7695b..92b881a 100644 --- a/inc/FSecCertX509CertificatePath.h +++ b/inc/FSecCertX509CertificatePath.h @@ -140,7 +140,7 @@ public: * @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 GetLength(). + * 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. diff --git a/inc/FSecCertX509CertificateStore.h b/inc/FSecCertX509CertificateStore.h index c092771..61dcf20 100644 --- a/inc/FSecCertX509CertificateStore.h +++ b/inc/FSecCertX509CertificateStore.h @@ -138,7 +138,7 @@ public: * @privilege %http://tizen.org/privilege/certificate.write * * @return An error code - * @param[in] certificateType The type of the Certificate (ROOT_CA, OPERATOR_DOMAIN, or TRUSTED_THIRD_PARTY_DOMAIN) + * @param[in] certificateType The type of the Certificate (@c ROOT_CA, @c OPERATOR_DOMAIN, or @c TRUSTED_THIRD_PARTY_DOMAIN) * @param[in] certificate A reference to the certificate to insert * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -159,7 +159,7 @@ public: * @privilege %http://tizen.org/privilege/certificate.write * * @return An error code - * @param[in] certificateType The type of the Certificate (ROOT_CA, OPERATOR_DOMAIN, or TRUSTED_THIRD_PARTY_DOMAIN) + * @param[in] certificateType The type of the Certificate (@c ROOT_CA, @c OPERATOR_DOMAIN, or @c TRUSTED_THIRD_PARTY_DOMAIN) * @param[in] oldCert A reference to the old certificate * @param[in] newCert A reference to the new certificate * @exception E_SUCCESS The method is successful. @@ -182,7 +182,7 @@ public: * @privilege %http://tizen.org/privilege/certificate.write * * @return An error code - * @param[in] certificateType The type of the Certificate (ROOT_CA, OPERATOR_DOMAIN, TRUSTED_THIRD_PARTY_DOMAIN) + * @param[in] certificateType The type of the Certificate (@c ROOT_CA, @c OPERATOR_DOMAIN, @c TRUSTED_THIRD_PARTY_DOMAIN) * @param[in] certificate A reference to the certificate to remove * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. diff --git a/inc/FSecCryptoAesCipher.h b/inc/FSecCryptoAesCipher.h index 7f762b4..50059b2 100644 --- a/inc/FSecCryptoAesCipher.h +++ b/inc/FSecCryptoAesCipher.h @@ -39,7 +39,8 @@ class _SymmetricCipher; * @since 2.0 * * The %AesCipher class provides a symmetric cipher using the Advanced Encryption Standard (AES) method. - * Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (CIPHER_ENCRYPT, CIPHER_DECRYPT, CIPHER_WRAP, or CIPHER_UNWRAP) parameters. @n + * Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::CIPHER_ENCRYPT, ::CIPHER_DECRYPT, ::CIPHER_WRAP, + * or ::CIPHER_UNWRAP) parameters. @n * * For more information on the class features, see Ciphers. * @@ -116,6 +117,7 @@ public: * Encrypts the data (single-part). * * @since 2.0 + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs @@ -130,7 +132,6 @@ public: * The method has failed to operate with the openssl library, or * the Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -138,7 +139,7 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -151,8 +152,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); @@ -211,7 +211,7 @@ public: * Wraps a key. * * @since 2.0 - * + * @pre Before calling this method, a secret key should be set using SetKey(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] secretKey The secret key to wrap @@ -223,8 +223,7 @@ public: * @exception E_UNSUPPORTED_ALGORITHM The specified cipher algorithm for this method is invalid. * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A key is set using SetKey() before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); @@ -232,7 +231,7 @@ public: * Unwraps a previously wrapped key. * * @since 2.0 - * + * @pre Before calling this method, a secret key should be set using SetKey(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap @@ -244,8 +243,7 @@ public: * @exception E_UNSUPPORTED_ALGORITHM The specified cipher algorithm for this method is invalid. * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A key is set using SetKey() before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoCastCipher.h b/inc/FSecCryptoCastCipher.h index c82c2ec..4048ccb 100644 --- a/inc/FSecCryptoCastCipher.h +++ b/inc/FSecCryptoCastCipher.h @@ -39,8 +39,8 @@ class _SymmetricCipher; * @since 2.0 * * The %CastCipher class provides a symmetric cipher using the CAST-128 algorithm. - * Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (CIPHER_ENCRYPT - * or CIPHER_DECRYPT) parameters. @n + * Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::CIPHER_ENCRYPT + * or ::CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. * @@ -117,7 +117,7 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -130,8 +130,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -139,7 +138,7 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -152,8 +151,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); @@ -161,7 +159,7 @@ public: * Initializes a multiple-part encryption or decryption operation. * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -169,7 +167,6 @@ public: * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library. - * @remarks A secret key and an initial vector are set before calling this method. */ virtual result Initialize(void); diff --git a/inc/FSecCryptoDesCipher.h b/inc/FSecCryptoDesCipher.h index dc6ef64..a875a01 100644 --- a/inc/FSecCryptoDesCipher.h +++ b/inc/FSecCryptoDesCipher.h @@ -40,7 +40,7 @@ class _SymmetricCipher; * * The %DesCipher class provides a symmetric cipher using the Data Encryption Standard (DES) method. * Sets appropriate values for the requested mode/key bit/padding scheme and cipher operation mode - * (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n + * (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. * @@ -117,7 +117,7 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -130,8 +130,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -139,7 +138,7 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -152,16 +151,15 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); /** * Initializes a multiple-part encryption or decryption operation. * - * @since 2.0 - * + * @since 2.0 + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -169,7 +167,6 @@ public: * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library. - * @remarks A secret key and an initial vector are set before calling this method. */ virtual result Initialize(void); @@ -217,9 +214,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] secretKey The secret key to wrap - * @remarks This operation is not supported in the %DesCipher class. - * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. + * @remarks + * - This operation is not supported in the %DesCipher class. + * Therefore, this method always returns @c null. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); @@ -231,9 +229,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap - * @remarks This operation is not supported in the %DesCipher class. - * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. + * @remarks + * - This operation is not supported in the %DesCipher class. + * Therefore, this method always returns @c null. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoDesEdeCipher.h b/inc/FSecCryptoDesEdeCipher.h index a39f077..f2b4400 100644 --- a/inc/FSecCryptoDesEdeCipher.h +++ b/inc/FSecCryptoDesEdeCipher.h @@ -39,7 +39,7 @@ class _SymmetricCipher; * @since 2.0 * * The %DesEdeCipher class provides symmetric cipher using the Data Encryption Standard in the Encrypt-Decrypt-Encrypt (DES-EDE) mode. - * Sets appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n + * Sets appropriate values for the requested mode/key bit/padding scheme and cipher operation (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. * @@ -115,7 +115,7 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -128,8 +128,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -137,7 +136,7 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -150,8 +149,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); @@ -159,7 +157,7 @@ public: * Initializes a multiple-part encryption or decryption operation. * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -167,7 +165,6 @@ public: * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library. - * @remarks A secret key and an initial vector are set before calling this method. */ virtual result Initialize(void); @@ -215,9 +212,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] secretKey The secret key to wrap - * @remarks This operation is not supported in the %DesEdeCipher class. - * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. + * @remarks + * - This operation is not supported in the %DesEdeCipher class. + * Therefore, this method always returns @c null. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); @@ -229,9 +227,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap - * @remarks This operation is not supported in the %DesEdeCipher class. - * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. + * @remarks + * - This operation is not supported in the %DesEdeCipher class. + * Therefore, this method always returns @c null. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoISymmetricCipher.h b/inc/FSecCryptoISymmetricCipher.h index 4cd16a0..d6108e4 100644 --- a/inc/FSecCryptoISymmetricCipher.h +++ b/inc/FSecCryptoISymmetricCipher.h @@ -379,8 +379,9 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks This operation is only supported in AesCipher. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - This operation is only supported in AesCipher. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey) = 0; @@ -400,8 +401,9 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the openssl library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks This operation is only supported in AesCipher. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - This operation is only supported in AesCipher. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey) = 0; diff --git a/inc/FSecCryptoRc2Cipher.h b/inc/FSecCryptoRc2Cipher.h index 123b5b0..005f6c6 100644 --- a/inc/FSecCryptoRc2Cipher.h +++ b/inc/FSecCryptoRc2Cipher.h @@ -119,7 +119,7 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -132,8 +132,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the OpenSSL library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -141,7 +140,7 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -154,8 +153,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the OpenSSL library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); @@ -163,7 +161,7 @@ public: * Initializes a multiple-part encryption or decryption operation. * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -171,7 +169,6 @@ public: * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the OpenSSL library. - * @remarks A secret key and an initial vector are set before calling this method. */ virtual result Initialize(void); @@ -219,9 +216,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] secretKey The secret key to wrap - * @remarks This operation is not supported in the %Rc2Cipher class. - * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. + * @remarks + * - This operation is not supported in the %Rc2Cipher class. + * Therefore, this method always returns @c null. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); @@ -233,9 +231,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap - * @remarks This operation is not supported in the %Rc2Cipher class. - * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. + * @remarks + * - This operation is not supported in the %Rc2Cipher class. + * Therefore, this method always returns @c null. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoRc4Cipher.h b/inc/FSecCryptoRc4Cipher.h index ac30c8e..d2bd3e1 100644 --- a/inc/FSecCryptoRc4Cipher.h +++ b/inc/FSecCryptoRc4Cipher.h @@ -116,7 +116,7 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -129,8 +129,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the OpenSSL library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -138,7 +137,7 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -151,8 +150,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the OpenSSL library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); @@ -160,15 +158,14 @@ public: * Initializes a multiple-part encryption or decryption operation. * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. - * @remarks A secret key and an initial vector are set before calling this method. + The method has failed to operate with the OpenSSL library. */ virtual result Initialize(void); @@ -217,9 +214,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] secretKey The secret key to wrap - * @remarks This operation is not supported in the %Rc4Cipher class. - * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM is returned using the GetLastResult() method. + * @remarks + * - This operation is not supported in the %Rc4Cipher class. + * Therefore, this method always returns @c null. + * - The @c E_UNSUPPORTED_ALGORITHM is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); @@ -231,9 +229,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap - * @remarks This operation is not supported in the %Rc4Cipher class. - * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM is returned using the GetLastResult() method. + * @remarks + * - This operation is not supported in the %Rc4Cipher class. + * Therefore, this method always returns @c null. + * - The @c E_UNSUPPORTED_ALGORITHM is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoSkipJackCipher.h b/inc/FSecCryptoSkipJackCipher.h index 4327764..8c1f67b 100755 --- a/inc/FSecCryptoSkipJackCipher.h +++ b/inc/FSecCryptoSkipJackCipher.h @@ -39,7 +39,7 @@ class _SymmetricCipher; * @since 2.0 * * The %SkipJackCipher class provides a symmetric cipher using the Skipjack algorithm. Appropriate values have to be set for the requested mode or key bit or - * padding scheme and the cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n + * padding scheme and the cipher operation (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. * @@ -118,7 +118,7 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -131,8 +131,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the OpenSSL library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -140,7 +139,7 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -153,8 +152,7 @@ public: * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the OpenSSL library, or * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks A secret key and an initial vector are set before calling this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); @@ -162,7 +160,7 @@ public: * Initializes a multiple-part encryption or decryption operation. * * @since 2.0 - * + * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -170,7 +168,6 @@ public: * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_SYSTEM A system error has occurred. @n * The method has failed to operate with the OpenSSL library. - * @remarks A secret key and an initial vector are set before calling this method. */ virtual result Initialize(void); @@ -218,8 +215,9 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] secretKey The secret key to wrap - * @remarks This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. + * @remarks + * - This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); @@ -231,8 +229,9 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap - * @remarks This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. @n - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. + * @remarks + * - This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. @n + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecPrivacyInfo.h b/inc/FSecPrivacyInfo.h index 2cd714e..2bd6004 100755 --- a/inc/FSecPrivacyInfo.h +++ b/inc/FSecPrivacyInfo.h @@ -52,8 +52,6 @@ public: * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.1 - * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance. */ PrivacyInfo(void); diff --git a/inc/FSecPrivilegeInfo.h b/inc/FSecPrivilegeInfo.h index 5569c5e..c4362a5 100755 --- a/inc/FSecPrivilegeInfo.h +++ b/inc/FSecPrivilegeInfo.h @@ -54,8 +54,6 @@ public: * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.1 - * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance. */ PrivilegeInfo(void);