merge with master

[framework/osp/net.git] / inc / FNetSockSecureSocket.h

diff --git a/inc/FNetSockSecureSocket.h b/inc/FNetSockSecureSocket.h
index b8e566a..73510e3 100755 (executable)
--- a/inc/FNetSockSecureSocket.h
+++ b/inc/FNetSockSecureSocket.h
@@ -192,7 +192,8 @@ public:
         * Use Ioctl() (with NET_SOCKET_FIONBIO) to use a %SecureSocket in the blocking mode.
         *
         * @since        2.0
-        * @privilege   %http://tizen.org/privilege/socket
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/socket
         *
         * @return              An error code
         * @param[in]   netConnection                   A run-time session where a %SecureSocket instance is used
@@ -236,7 +237,8 @@ public:
         * Use Ioctl() (with NET_SOCKET_FIONBIO) to use a %SecureSocket in the blocking mode.
         *
         * @since        2.0
-        * @privilege   %http://tizen.org/privilege/socket
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/socket
         *
         * @return              An error code
         * @param[in]   addressFamily                   A ::NetSocketAddressFamily value
@@ -278,7 +280,8 @@ public:
         * All the resources associated with the secure socket are freed.
         *
         * @since        2.0
-        * @privilege   %http://tizen.org/privilege/socket
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/socket
         *
         * @return              An error code
         * @exception   E_SUCCESS                                       The method is successful.
@@ -299,12 +302,13 @@ public:
         * @if OSPCOMPAT
         * @brief <i> [Compatibility] </i>
         * @endif
-        * @since            2.0
+        * @since                       2.0
         * @if OSPCOMPAT
         * @compatibility       This method has compatibility issues with OSP compatible applications. @n
      *                 For more information, see @ref SecureSocketConnectPage "here".
      * @endif
-        * @privilege           %http://tizen.org/privilege/socket
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/socket
         *
         * @return                      An error code
         * @param[in]           remoteEndPoint                          An instance of NetEndPoint representing the remote device
@@ -337,11 +341,11 @@ public:
         * @page                        SecureSocketConnectPage         Compatibility for Connect()
         *
         * @section             SecureSocketConnectPageIssueSection Issues
-        * Implementing this method in OSP compatible applications has the following issues:   @n
+        * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
         * -# If the application provides a loopback address in NetEndPoint, it returns E_SYSTEM.
         *
         * @section             SecureSocketConnectPageResolutionSection Resolutions
-        *  This issue has been resolved in Tizen.  @n 
+        *  The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n
         *  -# If the application provides a loopback address in NetEndPoint, it returns E_SUCCESS instead of E_SYSTEM.
         */
 
@@ -474,8 +478,9 @@ public:
        /**
        * Binds the secure socket to a local address.
        *
-       * @since        2.0
-       * @privilege    %http://tizen.org/privilege/socket
+       * @since                        2.0
+       * @privlevel            public
+       * @privilege            http://tizen.org/privilege/socket
        *
        * @return               An error code
        * @param[in]    localEndPoint                           The local NetEndPoint to associate with the secure socket
@@ -499,8 +504,9 @@ public:
        /**
        * Places the secure socket in a listening state.
        *
-       * @since        2.0
-       * @privilege    %http://tizen.org/privilege/socket
+       * @since                        2.0
+       * @privlevel            public
+       * @privilege            http://tizen.org/privilege/socket
        *
        * @return               An error code
        * @param[in]    backLog                                         The maximum length of the pending connections queue
@@ -528,23 +534,24 @@ public:
        * creates a new secure socket with the same socket type, protocol type, and protocol family
        * as the listening secure socket.
        *
-       * @since        2.0
-       * @privilege    %http://tizen.org/privilege/socket
+       * @since                        2.0
+       * @privlevel            public
+       * @privilege            http://tizen.org/privilege/socket
        *
        * @return               A new secure socket for a newly created connection with the same socket type, protocol type, and protocol family, @n
        *                               else @c null if an error occurs
        * @exception    E_SUCCESS                                       The method is successful.
        * @exception    E_WOULD_BLOCK                           A non-blocking secure socket operation cannot be completed immediately.
        * @exception    E_INVALID_CERTIFICATE           The server certificate verification has failed on client.
-       * @exception    E_CERTIFICATE_VERIFICATION_FAILED  The client certificate verification has failed.
+       * @exception    E_CERTIFICATE_VERIFICATION_FAILED  The client certificate verification has failed.
        * @exception    E_INVALID_SOCKET                        The secure socket is invalid.
        * @exception    E_INVALID_STATE                         The secure socket is not in a valid state.
        * @exception    E_UNSUPPORTED_OPTION            This operation is not supported for this socket.
        * @exception    E_NETWORK_UNAVAILABLE           The network is unavailable.
        * @exception    E_TIMEOUT                                       An attempt to connect to the server has timed out.
-       * @exception    E_OUT_OF_MEMORY                         The memory is insufficient.
+       * @exception    E_OUT_OF_MEMORY                         The memory is insufficient.
        * @exception    E_SYSTEM                                        A system error has occurred.
-       * @exception    E_PRIVILEGE_DENIED                      The application does not have the privilege to call this method.
+       * @exception    E_PRIVILEGE_DENIED                      The application does not have the privilege to call this method.
        * @remarks              Before calling this method, the Listen() method must be called first
        *                               to listen for and queue the incoming connection requests.
        *                               In the blocking mode, this method blocks until an incoming connection attempt
@@ -560,7 +567,8 @@ public:
         * Executes the specified command on the socket.
         *
         * @since        2.0
-        * @privilege         %http://tizen.org/privilege/socket
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/socket
         *
         * @return              An error code
         * @param[in]   cmd                                 The command to execute on the secure socket