Apply reviewed doxygen header
[platform/framework/native/appfw.git] / inc / FSecISecureRandom.h
index 136a3b7..bdefc20 100644 (file)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -34,11 +33,11 @@ namespace Tizen { namespace Security
  *     @interface      ISecureRandom
  *     @brief          This interface provides the abstract methods for generating a secure random object.
  *
- *  @since      2.0
+ *     @since          2.0
  *
- *  The %ISecureRandom interface provides the abstract methods for generating a secure random object. @n
+ *     The %ISecureRandom interface provides the abstract methods for generating a secure random object. @n
  *
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/key_mgmt_and_csprng.htm">Key Management and CSPRNG</a>.
+ *     For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/key_mgmt_and_csprng.htm">Key Management and CSPRNG</a>.
  *
  *     @see    Tizen::Security::AesSecureRandom
  *     @see    Tizen::Security::DesSecureRandom
@@ -49,8 +48,8 @@ class _OSP_EXPORT_ ISecureRandom
 
 public:
        /**
-        * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
-        * are called when the destructor of this interface is called.
+        * This polymorphic destructor should be overridden if required. @n 
+        * This way, the destructors of the derived classes are called when the destructor of this interface is called.
         *
         * @since               2.0
         */
@@ -67,10 +66,11 @@ public:
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
         *      @exception      E_INVALID_ARG                   The specified @c numBytes is @c 0 or negative.
-        *      @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.
-
+        *      @exception      E_SYSTEM                                Either of the following conditions has occurred:
+        *                                                                              - A system error has occurred.
+        *                                                                              - The method has failed to operate with the OpenSSL library.
+        *                                                                              - The Tizen::Base::ByteBuffer operation has failed.      
+        *      @remarks The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Base::ByteBuffer* GenerateRandomBytesN(int numBytes) = 0;