X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSecPkcsPkcs08Attribute.h;h=468e94cfa1c1786418c78f272e3cde1f9160f4ef;hb=d6a5cb0833a49efab12f1f9e7b6107080b7fd719;hp=284da3a54aebfd059ac5145a86d655acd7280d04;hpb=f82580836f6cc4193aefcea56e44b38301559b76;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FSecPkcsPkcs08Attribute.h b/inc/FSecPkcsPkcs08Attribute.h old mode 100644 new mode 100755 index 284da3a..468e94c --- a/inc/FSecPkcsPkcs08Attribute.h +++ b/inc/FSecPkcsPkcs08Attribute.h @@ -34,11 +34,14 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @class Pkcs08Attribute - * @brief This 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, encoding X.509 AttributeValue. + * @brief This class implements the functionalities specified by the %Pkcs08Attribute class. + * * @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. + * */ class _OSP_EXPORT_ Pkcs08Attribute @@ -61,78 +64,77 @@ public: virtual ~Pkcs08Attribute(void); /** - * Intializes this instance of %Pkcs08Attribute with the Bytebuffer which contain X.509 Attribute @n - * structure in ASN.1 DER format. @n + * Intializes this instance of %Pkcs08Attribute with the Tizen::Base::Bytebuffer that contains the X.509 attribute @n + * structure in ASN.1 DER format. * * @since 2.1 * * @return An error code - * @param[in] encodedData DER encoded Bytebuffer of X.509 Attribute structure. + * @param[in] encodedData The DER encoded Bytebuffer containing the X.509 attribute structure * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); /** - * Intializes this instance of %Pkcs08Attribute with specified attribute type. + * Intializes this instance of %Pkcs08Attribute with the specified attribute type. * * @since 2.1 * * @return An error code - * @param[in] attributeType This parameter specifies object Identifier of particular x.509 attribute type. Object IDs @n - * (e.g. oid for name is 2.5.4.41)are defined by standard bodies for attribute. + * @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); /** - * Get the attribute type. - * This function implements GetAttributeType API which returns the Attribute type of this attribute instance. + * Gets the attribute type. @n + * The %GetAttributeType() method implements GetAttributeType that returns the attribute type of this attribute instance. * * @since 2.1 * - * @return Containing the Object ID of Attribute Type in string format like 2.5.4.41 + * @return Containing the object ID of attribute type in string format like 2.5.4.41 * */ Tizen::Base::String GetAttributeType(void) const; /** - * This function adds attribute value in the attribute value list. + * Adds an 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 to add an attribute in the list */ result AddAttributeValue(const Pkcs08AttributeValue& attributeValue); /** - * This function remove attribute value in the attribute value list. + * Removes an 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 in the list. + * @param[in] attributeValue An instance of Pkcs08AttributeValue to remove an attribute from the list */ result RemoveAttributeValue(const Pkcs08AttributeValue& attributeValue); /** - * This function returns the array list containing the attribute values of type Pkcs08AttributeValue. + * Returns an array list containing the attribute values of type Pkcs08AttributeValue. * * @since 2.1 * - * @return A reference to an ArrayList containing the list of Attribute values. + * @return A reference to an ArrayList containing the list of attribute values */ const Tizen::Base::Collection::ArrayList& GetAttributeValues(void) const; /** - * Gets the encoded form of the Pkcs08Attribute. - * It is assumed that each Pkcs08Attribute will have only a single form of encoding example ASN.1 DER. + * Gets the encoded form of Pkcs08Attribute. + * It is assumed that each %Pkcs08Attribute will have only a single form of encoding, for example ASN.1 DER. * * @since 2.1 * - * @return A pointer to the ByteBuffer class that contains the output, @n + * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * * @exception E_SUCCESS The method is successful.