Add description for mobile profile

Change-Id: Ic07dffcb529b5058f81426f1fb9e884646072a4c
Signed-off-by: Junghoon Park <jh9216.park@samsung.com>

diff --git a/include/rpc-port-parcel.h b/include/rpc-port-parcel.h
index 4ba9f9f..1a41a3f 100644 (file)
--- a/include/rpc-port-parcel.h
+++ b/include/rpc-port-parcel.h
@@ -31,12 +31,14 @@ extern "C" {
  */
 
 /**
+ * @MOBILE_ONLY
  * @brief The rpc port parcel handle.
  * @since_tizen 4.0
  */
 typedef void *rpc_port_parcel_h;
 
 /**
+ * @MOBILE_ONLY
  * @brief The interface for converting data to/from a parcel.
  * @since_tizen 4.0
  */
@@ -46,6 +48,7 @@ typedef struct __rpc_port_parcelable {
 } rpc_port_parcelable_t;
 
 /**
+ * @MOBILE_ONLY
  * @brief Creates a rpc port parcel handle.
  * @since_tizen 4.0
  * @remarks You must release @a h using rpc_port_parcel_destroy().
@@ -58,6 +61,7 @@ typedef struct __rpc_port_parcelable {
 int rpc_port_parcel_create(rpc_port_parcel_h *h);
 
 /**
+ * @MOBILE_ONLY
  * @brief Creates a rpc port parcel handle from port.
  * @details Creates a rpc port parcel handle using read data from the port.
  *          It calls rpc_port_read() internally.
@@ -76,6 +80,7 @@ int rpc_port_parcel_create(rpc_port_parcel_h *h);
 int rpc_port_parcel_create_from_port(rpc_port_parcel_h *h, rpc_port_h port);
 
 /**
+ * @MOBILE_ONLY
  * @brief Sends parcel data through the port.
  * @details Sends parcel data through the port. It calls rpc_port_write()
  *          internally.
@@ -92,6 +97,7 @@ int rpc_port_parcel_create_from_port(rpc_port_parcel_h *h, rpc_port_h port);
 int rpc_port_parcel_send(rpc_port_parcel_h h, rpc_port_h port);
 
 /**
+ * @MOBILE_ONLY
  * @brief Destroys a rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -104,6 +110,7 @@ int rpc_port_parcel_send(rpc_port_parcel_h h, rpc_port_h port);
 int rpc_port_parcel_destroy(rpc_port_parcel_h h);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes a byte value into rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -117,6 +124,7 @@ int rpc_port_parcel_destroy(rpc_port_parcel_h h);
 int rpc_port_parcel_write_byte(rpc_port_parcel_h h, char b);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes a short value into rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -130,6 +138,7 @@ int rpc_port_parcel_write_byte(rpc_port_parcel_h h, char b);
 int rpc_port_parcel_write_int16(rpc_port_parcel_h h, short i);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes a integer value into rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -143,6 +152,7 @@ int rpc_port_parcel_write_int16(rpc_port_parcel_h h, short i);
 int rpc_port_parcel_write_int32(rpc_port_parcel_h h, int i);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes a long long integer value into rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -156,6 +166,7 @@ int rpc_port_parcel_write_int32(rpc_port_parcel_h h, int i);
 int rpc_port_parcel_write_int64(rpc_port_parcel_h h, long long i);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes a floating point value into rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -169,6 +180,7 @@ int rpc_port_parcel_write_int64(rpc_port_parcel_h h, long long i);
 int rpc_port_parcel_write_float(rpc_port_parcel_h h, float f);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes a double precision floating point value into rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -182,6 +194,7 @@ int rpc_port_parcel_write_float(rpc_port_parcel_h h, float f);
 int rpc_port_parcel_write_double(rpc_port_parcel_h h, double d);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes a string value into rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -195,6 +208,7 @@ int rpc_port_parcel_write_double(rpc_port_parcel_h h, double d);
 int rpc_port_parcel_write_string(rpc_port_parcel_h h, const char *str);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes a boolean value into rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -208,6 +222,7 @@ int rpc_port_parcel_write_string(rpc_port_parcel_h h, const char *str);
 int rpc_port_parcel_write_bool(rpc_port_parcel_h h, bool b);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes a bundle data into rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -221,6 +236,7 @@ int rpc_port_parcel_write_bool(rpc_port_parcel_h h, bool b);
 int rpc_port_parcel_write_bundle(rpc_port_parcel_h h, bundle *b);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes a count for array into rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -234,6 +250,7 @@ int rpc_port_parcel_write_bundle(rpc_port_parcel_h h, bundle *b);
 int rpc_port_parcel_write_array_count(rpc_port_parcel_h h, int count);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes the data into parcel handle using @a parcelable.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -248,6 +265,7 @@ int rpc_port_parcel_write_array_count(rpc_port_parcel_h h, int count);
 int rpc_port_parcel_write(rpc_port_parcel_h h, rpc_port_parcelable_t *parcelable, void *data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a byte value from rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -261,6 +279,7 @@ int rpc_port_parcel_write(rpc_port_parcel_h h, rpc_port_parcelable_t *parcelable
 int rpc_port_parcel_read_byte(rpc_port_parcel_h h, char *b);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a short value from rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -274,6 +293,7 @@ int rpc_port_parcel_read_byte(rpc_port_parcel_h h, char *b);
 int rpc_port_parcel_read_int16(rpc_port_parcel_h h, short *i);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a integer value from rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -287,6 +307,7 @@ int rpc_port_parcel_read_int16(rpc_port_parcel_h h, short *i);
 int rpc_port_parcel_read_int32(rpc_port_parcel_h h, int *i);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a long long integer value from rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -300,6 +321,7 @@ int rpc_port_parcel_read_int32(rpc_port_parcel_h h, int *i);
 int rpc_port_parcel_read_int64(rpc_port_parcel_h h, long long *i);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a floating point value from rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -313,6 +335,7 @@ int rpc_port_parcel_read_int64(rpc_port_parcel_h h, long long *i);
 int rpc_port_parcel_read_float(rpc_port_parcel_h h, float *f);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a double precision floating point value from rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -326,6 +349,7 @@ int rpc_port_parcel_read_float(rpc_port_parcel_h h, float *f);
 int rpc_port_parcel_read_double(rpc_port_parcel_h h, double *d);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a string value from rpc port parcel handle.
  * @since_tizen 4.0
  * @remarks The @a str should be released using free().
@@ -340,6 +364,7 @@ int rpc_port_parcel_read_double(rpc_port_parcel_h h, double *d);
 int rpc_port_parcel_read_string(rpc_port_parcel_h h, char **str);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a boolean value from rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -353,6 +378,7 @@ int rpc_port_parcel_read_string(rpc_port_parcel_h h, char **str);
 int rpc_port_parcel_read_bool(rpc_port_parcel_h h, bool *b);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a bundle data from rpc port parcel handle.
  * @since_tizen 4.0
  * @remarks The @a b should be released using bundle_free().
@@ -367,6 +393,7 @@ int rpc_port_parcel_read_bool(rpc_port_parcel_h h, bool *b);
 int rpc_port_parcel_read_bundle(rpc_port_parcel_h h, bundle **b);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a count for array from rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -380,6 +407,7 @@ int rpc_port_parcel_read_bundle(rpc_port_parcel_h h, bundle **b);
 int rpc_port_parcel_read_array_count(rpc_port_parcel_h h, int *count);
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads a parcel from the data using @a parcelable.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -395,6 +423,7 @@ int rpc_port_parcel_read(rpc_port_parcel_h h, rpc_port_parcelable_t *parcelable,
 
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads bytes from rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle
@@ -409,6 +438,7 @@ int rpc_port_parcel_read(rpc_port_parcel_h h, rpc_port_parcelable_t *parcelable,
 int rpc_port_parcel_burst_read(rpc_port_parcel_h h, unsigned char *buf, unsigned int size);
 
 /**
+ * @MOBILE_ONLY
  * @brief Write bytes to rpc port parcel handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port parcel handle

diff --git a/include/rpc-port.h b/include/rpc-port.h
index f14aac0..f06d198 100755 (executable)
--- a/include/rpc-port.h
+++ b/include/rpc-port.h
@@ -31,6 +31,7 @@ extern "C" {
 
 
 /**
+ * @MOBILE_ONLY
  * @brief Enumeration for error codes of a rpc port.
  * @since_tizen 4.0
  */
@@ -43,6 +44,7 @@ typedef enum {
 } rpc_port_error_e;
 
 /**
+ * @MOBILE_ONLY
  * @brief Enumeration for types of communication channels.
  * @since_tizen 4.0
  */
@@ -54,12 +56,14 @@ typedef enum {
 /* Common */
 
 /**
+ * @MOBILE_ONLY
  * @brief The rpc port handle.
  * @since_tizen 4.0
  */
 typedef void *rpc_port_h;
 
 /**
+ * @MOBILE_ONLY
  * @brief Reads data from an RPC port.
  * @since_tizen 4.0
  *
@@ -77,6 +81,7 @@ typedef void *rpc_port_h;
 int rpc_port_read(rpc_port_h h, void *buf, unsigned int size);
 
 /**
+ * @MOBILE_ONLY
  * @brief Writes data to an RPC port.
  * @since_tizen 4.0
  *
@@ -97,6 +102,7 @@ int rpc_port_write(rpc_port_h h, const void *buf, unsigned int size);
 /* Proxy */
 
 /**
+ * @MOBILE_ONLY
  * @brief Called when the proxy is connected.
  * @details The function is called when the proxy is connected with stub by port.
  * @since_tizen 4.0
@@ -109,6 +115,7 @@ typedef void (*rpc_port_proxy_connected_event_cb)(const char *receiver,
                const char *port_name, rpc_port_h port, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Called when the proxy is disconnected.
  * @details The function is called when the proxy is disconnected from stub.
  * @since_tizen 4.0
@@ -120,6 +127,7 @@ typedef void (*rpc_port_proxy_disconnected_event_cb)(const char *receiver,
                const char *port_name, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Called when the proxy is rejected.
  * @details The function is called when the proxy is rejected to connect stub.
  * @since_tizen 4.0
@@ -131,6 +139,7 @@ typedef void (*rpc_port_proxy_rejected_event_cb)(const char *receiver,
                const char *port_name, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Called when the proxy received data.
  * @details The function is called when the proxy received data from stub.
  * @since_tizen 4.0
@@ -142,12 +151,14 @@ typedef void (*rpc_port_proxy_received_event_cb)(const char *receiver,
                const char *port_name, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief The rpc port proxy handle.
  * @since_tizen 4.0
  */
 typedef void *rpc_port_proxy_h;
 
 /**
+ * @MOBILE_ONLY
  * @brief Creates a rpc port proxy handle.
  * @since_tizen 4.0
  * @remarks You must release @a h using rpc_port_proxy_destroy().
@@ -161,6 +172,7 @@ typedef void *rpc_port_proxy_h;
 int rpc_port_proxy_create(rpc_port_proxy_h *h);
 
 /**
+ * @MOBILE_ONLY
  * @brief Destroys a rpc port proxy handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port proxy handle
@@ -173,6 +185,7 @@ int rpc_port_proxy_create(rpc_port_proxy_h *h);
 int rpc_port_proxy_destroy(rpc_port_proxy_h h);
 
 /**
+ * @MOBILE_ONLY
  * @brief Connects to @a port of @a appid.
  * @details To send and receive data, the proxy should connect to port of stub
  * @since_tizen 4.0
@@ -194,6 +207,7 @@ int rpc_port_proxy_connect(rpc_port_proxy_h h, const char *appid,
                const char *port);
 
 /**
+ * @MOBILE_ONLY
  * @brief Adds a proxy connected callback.
  * @since_tizen 4.0
  * @param[in] h The rpc port proxy handle
@@ -209,6 +223,7 @@ int rpc_port_proxy_add_connected_event_cb(rpc_port_proxy_h h,
                rpc_port_proxy_connected_event_cb cb, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Adds a proxy disconnected callback.
  * @since_tizen 4.0
  * @param[in] h The rpc port proxy handle
@@ -224,6 +239,7 @@ int rpc_port_proxy_add_disconnected_event_cb(rpc_port_proxy_h h,
                rpc_port_proxy_disconnected_event_cb cb, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Adds a proxy rejected callback.
  * @since_tizen 4.0
  * @param[in] h The rpc port proxy handle
@@ -239,6 +255,7 @@ int rpc_port_proxy_add_rejected_event_cb(rpc_port_proxy_h h,
                rpc_port_proxy_rejected_event_cb cb, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Adds a proxy received callback.
  * @since_tizen 4.0
  * @param[in] h The rpc port proxy handle
@@ -254,6 +271,7 @@ int rpc_port_proxy_add_received_event_cb(rpc_port_proxy_h h,
                rpc_port_proxy_received_event_cb cb, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Gets a port from proxy handle.
  * @since_tizen 4.0
  * @remarks This handle @a port will not be valid if the proxy was disconnected or destroyed.
@@ -276,12 +294,14 @@ int rpc_port_proxy_get_port(rpc_port_proxy_h h, rpc_port_port_type_e type,
 /* Stub */
 
 /**
+ * @MOBILE_ONLY
  * @brief The rpc port stub handle.
  * @since_tizen 4.0
  */
 typedef void *rpc_port_stub_h;
 
 /**
+ * @MOBILE_ONLY
  * @brief Called when the proxy is connected with stub.
  * @details The function is called when the proxy is connected with stub.
  *          When a proxy connects to stub several times with new port,
@@ -295,6 +315,7 @@ typedef void (*rpc_port_stub_connected_event_cb)(const char *sender,
                const char *instance, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Called when the proxy is disconnected from stub.
  * @details The function is called when the proxy is disconnected from stub.
  *          When a proxy is disconnected, you can check the request
@@ -308,6 +329,7 @@ typedef void (*rpc_port_stub_disconnected_event_cb)(const char *sender,
                const char *instance, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Called when the stub received data from proxy.
  * @details The function is called when the stub received data from stub.
  *          When a stub received data from several ports, you can handle
@@ -325,6 +347,7 @@ typedef int (*rpc_port_stub_received_event_cb)(const char *sender,
                const char *instance, rpc_port_h port, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Creates a rpc port stub handle.
  * @since_tizen 4.0
  * @remarks You must release @a h using rpc_port_stub_destroy().
@@ -339,6 +362,7 @@ typedef int (*rpc_port_stub_received_event_cb)(const char *sender,
 int rpc_port_stub_create(rpc_port_stub_h *h, const char *port_name);
 
 /**
+ * @MOBILE_ONLY
  * @brief Destroys a rpc port stub handle.
  * @since_tizen 4.0
  * @param[in] h The rpc port stub handle
@@ -351,6 +375,7 @@ int rpc_port_stub_create(rpc_port_stub_h *h, const char *port_name);
 int rpc_port_stub_destroy(rpc_port_stub_h h);
 
 /**
+ * @MOBILE_ONLY
  * @brief Listens to the requests for connections.
  * @details The stub listens requests to connect by port
  * @since_tizen 4.0
@@ -364,6 +389,7 @@ int rpc_port_stub_destroy(rpc_port_stub_h h);
 int rpc_port_stub_listen(rpc_port_stub_h h);
 
 /**
+ * @MOBILE_ONLY
  * @brief Adds a privilege to the stub.
  * @details The stub can control access to the port using tizen privilege.
  *          It allows connections only if the proxy which have the privileges.
@@ -378,6 +404,7 @@ int rpc_port_stub_listen(rpc_port_stub_h h);
 int rpc_port_stub_add_privilege(rpc_port_stub_h h, const char *privilege);
 
 /**
+ * @MOBILE_ONLY
  * @brief Sets trusted to the stub.
  * @details The stub can control access to the port using tizen certificate.
  *          It allows connections only if the proxy is signed with the same
@@ -393,6 +420,7 @@ int rpc_port_stub_add_privilege(rpc_port_stub_h h, const char *privilege);
 int rpc_port_stub_set_trusted(rpc_port_stub_h h, const bool trusted);
 
 /**
+ * @MOBILE_ONLY
  * @brief Adds a stub connected callback.
  * @since_tizen 4.0
  * @param[in] h The rpc stub stub handle
@@ -409,6 +437,7 @@ int rpc_port_stub_add_connected_event_cb(rpc_port_stub_h h,
                rpc_port_stub_connected_event_cb cb, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Adds a stub disconnected callback.
  * @since_tizen 4.0
  * @param[in] h The rpc port stub handle
@@ -425,6 +454,7 @@ int rpc_port_stub_add_disconnected_event_cb(rpc_port_stub_h h,
                rpc_port_stub_disconnected_event_cb cb, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Adds a stub received callback.
  * @since_tizen 4.0
  * @param[in] h The rpc port stub handle
@@ -440,6 +470,7 @@ int rpc_port_stub_add_received_event_cb(rpc_port_stub_h h,
                rpc_port_stub_received_event_cb cb, void *user_data);
 
 /**
+ * @MOBILE_ONLY
  * @brief Gets a port from stub handle.
  * @since_tizen 4.0
  * @remarks This handle @a port will not be valid if the instance of the stub was disconnected or destroyed.