Apply reviewed doxygen header

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

diff --git a/inc/FSecPkcsPkcs08Attribute.h b/inc/FSecPkcsPkcs08Attribute.h
index 9f524db..e78e6af 100755 (executable)
--- a/inc/FSecPkcsPkcs08Attribute.h
+++ b/inc/FSecPkcsPkcs08Attribute.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);
@@ -39,8 +38,8 @@ namespace Tizen { namespace Security { namespace Pkcs
  * @since              2.1
  *
  * The %Pkcs08Attribute class implements the functionalities specified by the %Pkcs08Attribute class. An Attribute object consists
- *                                     of an attribute type (specified by an object identifier) and one or more attribute values. It acts as a
- *                                     container for adding, inserting, removing, and encoding X.509 AttributeValue.
+ * of an attribute type (specified by an object identifier) and one or more attribute values. It acts as a
+ * container for adding, inserting, removing, and encoding X.509 AttributeValue.
  *
  */
 
@@ -64,14 +63,14 @@ public:
        virtual ~Pkcs08Attribute(void);
 
        /**
-        * Initializes this instance of %Pkcs08Attribute with the Tizen::Base::ByteBuffer that contains the X.509 attribute @n
+        * Initializes this instance of %Pkcs08Attribute with the specified Tizen::Base::ByteBuffer instance that contains the X.509 attribute 
         * structure in ASN.1 DER format.
         *
         * @since               2.1
         *
         * @return              An error code
         * @param[in]   encodedData                             The DER encoded Tizen::Base::ByteBuffer containing the X.509 attribute structure
-        * @exception   E_SUCCESS                                       The method is successful.
+        * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_INVALID_ARG                   The specified input parameter is invalid.
         */
        result Construct(const Tizen::Base::ByteBuffer& encodedData);
@@ -82,8 +81,9 @@ public:
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   attributeType                   The object identifier of a particular X.509 attribute type @n Object IDs (for example, oid for name is 2.5.4.41) are defined by standard attribute bodies.
-        * @exception   E_SUCCESS                                       The method is successful.
+        * @param[in]   attributeType                   The object identifier of a particular X.509 attribute type @n 
+        *                                                                              Object IDs (for example, oid for name is 2.5.4.41) are defined by standard attribute bodies.
+        * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_INVALID_ARG                   The specified input parameter is invalid.
         */
        result Construct(const Tizen::Base::String& attributeType);
@@ -94,33 +94,33 @@ public:
         *
         * @since               2.1
         *
-        * @return              Containing the object ID of attribute type in string format like 2.5.4.41
+        * @return              The string with the object ID of attribute type like 2.5.4.41
         *
         */
        Tizen::Base::String GetAttributeType(void) const;
 
        /**
-        * Adds an attribute value in the attribute value list.
+        * Adds the attribute value in the attribute value list.
         *
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   attributeValue                  An instance of Pkcs08AttributeValue to add an attribute in the list
+        * @param[in]   attributeValue                  An instance of Pkcs08AttributeValue
         */
        result AddAttributeValue(const Pkcs08AttributeValue& attributeValue);
 
        /**
-        * Removes an attribute value from the attribute value list.
+        * Removes the attribute value from the attribute value list.
         *
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   attributeValue                  An instance of Pkcs08AttributeValue to remove an attribute from the list
+        * @param[in]   attributeValue                  An instance of Pkcs08AttributeValue
         */
        result RemoveAttributeValue(const Pkcs08AttributeValue& attributeValue);
 
        /**
-        * Returns an array list containing the attribute values of type Pkcs08AttributeValue.
+        * Gets an array list containing the attribute values of type Pkcs08AttributeValue.
         *
         * @since               2.1
         *
@@ -135,7 +135,7 @@ public:
         * @since               2.1
         *
         * @return              A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
-        *                                              else @c null if an error occurs
+        *                              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.