Revise Tizen::Io doxygen

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

diff --git a/inc/FIoClientChannel.h b/inc/FIoClientChannel.h
index 1d61b0a..4b5f350 100644 (file)
--- a/inc/FIoClientChannel.h
+++ b/inc/FIoClientChannel.h
@@ -14,10 +14,12 @@
 // limitations under the License.
 //
 /**
+ * @if OSPDEPREC
  * @file               FIoClientChannel.h
  * @brief              This is the header file for the %ClientChannel class.
  *
  * This header file contains the declarations of the %ClientChannel class.
+ * @endif
  */
 #ifndef _FIO_CLIENT_CHANNEL_H_
 #define _FIO_CLIENT_CHANNEL_H_
@@ -44,8 +46,6 @@ namespace Tizen { namespace Io
 * The %ClientChannel class provides methods for sending a request to another application's ServerChannel. To receive a response
 * for the request, set the ChannelResponseEventListener interface. The instance of %ClientChannel can be retrieved
 * using ClientChannel::GetInstance().
-* @n
-* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/io/channels.htm">Channel Communication</a>.
 *
 * The following example demonstrates how to use the %ClientChannel class.
 *
@@ -126,7 +126,7 @@ public:
        *
        * @since 2.0
        *
-       * @return       A pointer to the %ClientChannel instance, @n
+       * @return       The pointer to the %ClientChannel instance, @n
        *                       else @c null if it fails
        * @exception    E_SUCCESS           The method is successful.
        * @exception    E_SYSTEM            The method cannot proceed due to a severe system error.
@@ -139,7 +139,7 @@ public:
        *
        * @since 2.0
        *
-       * @return       A pointer to the %ClientChannel instance, @n
+       * @return       The pointer to the %ClientChannel instance, @n
        *                       else @c null if it fails
        * @param[in]     channelName         The channel name
        * @exception     E_SUCCESS           The method is successful.
@@ -163,13 +163,13 @@ public:
         *
         * @since 2.0
         *
-        * @return       An error code
-        * @param[in]     serverChannelId    The server channel ID which can be either application ID or appicationID.ChannelName
-        * @param[in]     pArgs               A pointer to an argument list of type String
-        * @param[out]    reqId               The request ID
-        * @exception     E_SUCCESS           The method is successful.
-        * @exception     E_OBJ_NOT_FOUND     The server channel is not found.
-        * @exception     E_SYSTEM            The method cannot proceed due to a severe system error.
+        * @return              An error code
+        * @param[in]   serverChannelId         The server channel ID which can be either application ID or appicationID.ChannelName
+        * @param[in]   pArgs                           A pointer to an argument list of type String
+        * @param[out]  reqId                           The request ID
+        * @exception   E_SUCCESS                       The method is successful.
+        * @exception   E_OBJ_NOT_FOUND         The server channel is not found.
+        * @exception   E_SYSTEM                        The method cannot proceed due to a severe system error.
         */
        result SendRequest(const Tizen::Base::String& serverChannelId, const Tizen::Base::Collection::IList* pArgs, RequestId& reqId);