Merge "Beautification of appfw/inc soure-code" into tizen_2.2

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

diff --git a/inc/FSecPkcsInitialVector.h b/inc/FSecPkcsInitialVector.h
old mode 100644 (file)
new mode 100755 (executable)
index b863263..c9695af
--- a/inc/FSecPkcsInitialVector.h
+++ b/inc/FSecPkcsInitialVector.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -34,11 +33,14 @@ namespace Tizen { namespace Security { namespace Pkcs
 
 /**
  * @class              InitialVector
- * @brief              This class implements the functionalities specified by the InitialVector class.
- *                                     This class represents the Initial Vector parameter for symmetric ciphers like DES, AES, DES_EDE.
- *                                     This InitialVector Parameters will be used by both Pkcs05 and Pkcs08 related classes at the time of encryption.
+ * @brief              This class implements the functionalities specified by the %InitialVector class.
+ *
  * @since              2.1
  *
+ * The %InitialVector class implements the functionalities specified by the %InitialVector class.
+ *                                     This class represents the Initial Vector parameter for symmetric ciphers such as DES, AES, DES_EDE.
+ *                                     This %InitialVector parameters will be used by both PKCS05 and PKCS08 related classes at the time of encryption.
+ *
  *
  */
 
@@ -71,28 +73,28 @@ public:
         *
         * @return              An error code
         *
-        * @param[in]   initialVector           An instance of ByteBuffer, holding the initial vector data.
+        * @param[in]   initialVector           An instance of Tizen::Base::ByteBuffer, holding the initial vector data
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_INVALID_ARG           The specified input parameter is invalid.
         */
        result Construct(const Tizen::Base::ByteBuffer& initialVector);
 
        /**
-        * Get copy of this instance.
+        * Gets copy of this instance.
         *
         * @since               2.1
         *
-        * @return              A pointer to IAlgorithmParameters, containing the copy of this instance.
+        * @return              A pointer to IAlgorithmParameters, containing the copy of this instance
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        virtual IAlgorithmParameters* CloneN(void) const;
 
        /**
-        * Get the algorithm parameter type enum value for Initial Vector.
+        * Gets the algorithm parameter type enum value for Initial Vector.
         *
         * @since               2.1
         *
-        * @return              PkcsAlgorithmParameterType              Enum value  containing the PKCS_ALGO_PARAM_TYPE_IV value for Initial vector parameter.
+        * @return              PkcsAlgorithmParameterType              Enum value containing the PKCS_ALGO_PARAM_TYPE_IV value for Initial Vector parameter
         *
         */
        virtual PkcsAlgorithmParameterType GetType(void) const;
@@ -121,11 +123,11 @@ public:
        virtual int GetHashCode(void) const;
 
        /**
-        * Get the instance of byte buffer that contains the Initial vector value.
+        * Gets the instance of Tizen::Base::ByteBuffer that contains the Initial Vector value.
         *
         * @since               2.1
         *
-        * @return              A reference to the ByteBuffer class that contains the output.
+        * @return              A reference to the Tizen::Base::ByteBuffer class that contains the output
         */
        const Tizen::Base::ByteBuffer& GetInitialVector(void) const;
 
@@ -135,8 +137,8 @@ public:
         *
         * @since               2.1
         *
-        * @return              Pointer to the DER encoded ByteBuffer, @n
-        *                                                      else @c null if an error occurs.
+        * @return              Pointer to the DER encoded Tizen::Base::ByteBuffer, @n
+        *                                                      else @c null if an error occurs
         * @exception   E_SUCCESS                                               The method is successful.
         * @exception   E_SYSTEM                                                The method cannot proceed due to a severe system error.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.