Revise descriptions

Descriptions are revised according to the recommendation
of review comments from ACR process.

[Version] 0.1.64
[Issue Type] Doxygen

Change-Id: I83c43b30cb9caccecba6b67e3670bff5062a2464
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>

diff --git a/include/media_streamer.h b/include/media_streamer.h
index 9b824a1..3cb4c5e 100644 (file)
--- a/include/media_streamer.h
+++ b/include/media_streamer.h
@@ -312,7 +312,7 @@ typedef enum {
 
 /**
  * @brief Definition for remote session description.
- * @details Value of the session description of the remote peer over its signaling channel
+ * @details Value of the session description of the remote peer over its signaling channel.
  *          Data type is string.
  * @since_tizen 6.0
  * @see media_streamer_node_get_params() */
@@ -320,7 +320,7 @@ typedef enum {
 
 /**
  * @brief Definition for ICE candidate of WebRTC node.
- * @details Value of ICE candidate of the remote peer over its signaling channel
+ * @details Value of ICE candidate of the remote peer over its signaling channel.
  *          Data type is string.
  * @since_tizen 6.0
  * @see media_streamer_node_get_params() */
@@ -538,7 +538,7 @@ typedef void (*media_streamer_position_changed_cb)(void *user_data);
 typedef void (*media_streamer_interrupted_cb)(media_streamer_interrupted_code_e code, void *user_data);
 
 /**
- * @brief Called when the media streamer node is ready for decoded data.
+ * @brief Called when a source pad of a media streamer node is ready to provide decoded data.
  * @since_tizen 6.0
  * @param[in] webrtc        Media streamer node handle
  * @param[in] src_pad_name  The source pad name that can give decoded data to another one
@@ -551,9 +551,9 @@ typedef void (*media_streamer_interrupted_cb)(media_streamer_interrupted_code_e
 typedef void (*media_streamer_node_decoded_ready_cb)(media_streamer_node_h node, const char *src_pad_name, const char *media_type, void *user_data);
 
 /**
- * @brief Called when the media streamer WebRTC node needs to send the message to the remote peer of WebRTC connection.
+ * @brief Called when the media streamer WebRTC node needs to send the message to the remote peer of the WebRTC connection.
  * @since_tizen 6.0
- * @remarks Two types will be delivered with @ message which is JSON string.
+ * @remarks Two types will be delivered with @ message which is a JSON string.
  *          One is for the remote session description and the other is for a new ICE candidate.
  *          For the remote session description, @ message will be {"sdp":{"type":"offer or answer","sdp":"..."}}.
  *          For the new ICE candidate, @ message will be {"ice":{"candidate":"..."}}.
@@ -1058,7 +1058,7 @@ int media_streamer_node_pull_packet(media_streamer_node_h sink, media_packet_h *
  * @since_tizen 3.0
  * @remarks The node type should not be #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
  *          To create source / sink type node, media_streamer_node_create_src() / media_streamer_node_create_sink() should be called.
- *          The internet privilege(%http://tizen.org/privilege/internet) should be added if #MEDIA_STREAMER_NODE_TYPE_WEBRTC is set.
+ *          The internet privilege (%http://tizen.org/privilege/internet) should be added if #MEDIA_STREAMER_NODE_TYPE_WEBRTC is set.
  *          You can release @a node using media_streamer_node_destroy().
  * @param[in]  type      Created node type
  * @param[in]  in_fmt    Media format handle for input data
@@ -1356,8 +1356,8 @@ int media_streamer_node_set_decoded_ready_cb(media_streamer_node_h node, media_s
 int media_streamer_node_unset_decoded_ready_cb(media_streamer_node_h node);
 
 /**
- * @brief Sets a callback function to be invoked when WebRTC node needs to send the message to the remote peer of WebRTC connection.
- * @details This function can be called only for #MEDIA_STREAMER_NODE_TYPE_WEBRTC type.
+ * @brief Sets a callback function to be invoked when WebRTC node needs to send a message to the remote peer of WebRTC connection.
+ * @details This function can be called only for #MEDIA_STREAMER_NODE_TYPE_WEBRTC type node.
  * @since_tizen 6.0
  * @param[in] webrtc    Media streamer WebRTC node handle
  * @param[in] callback  The WebRTC message callback function to register
@@ -1374,7 +1374,7 @@ int media_streamer_node_unset_decoded_ready_cb(media_streamer_node_h node);
 int media_streamer_webrtc_node_set_message_cb(media_streamer_node_h webrtc, media_streamer_webrtc_message_cb callback, void *user_data);
 
 /**
- * @brief Unsets the webrtc message callback function.
+ * @brief Unsets the WebRTC message callback function.
  * @since_tizen 6.0
  * @param[in] src    Media streamer WebRTC node handle
  * @return @c 0 on success,

diff --git a/packaging/capi-media-streamer.spec b/packaging/capi-media-streamer.spec
index ae2c48b..63ac8a5 100644 (file)
--- a/packaging/capi-media-streamer.spec
+++ b/packaging/capi-media-streamer.spec
@@ -1,6 +1,6 @@
 Name:       capi-media-streamer
 Summary:    A Media Streamer API
-Version:    0.1.63
+Version:    0.1.64
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0