Add availability information of parameters in callback prototypes

These are added in @remarks paragraph.
More '\n' are added to separate lines.

[Version] 0.1.83
[Issue Type] Doxygen

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

diff --git a/include/media_streamer.h b/include/media_streamer.h
index c328980..ff8f977 100644 (file)
--- a/include/media_streamer.h
+++ b/include/media_streamer.h
@@ -447,11 +447,12 @@ typedef enum {
  * @brief Called when error occurs in media streamer.
  * @since_tizen 3.0
  * @remarks Following error codes can be delivered.\n
- *          #MEDIA_STREAMER_ERROR_INVALID_OPERATION,
- *          #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,
- *          #MEDIA_STREAMER_ERROR_NOT_SUPPORTED,
- *          #MEDIA_STREAMER_ERROR_CONNECTION_FAILED,
- *          #MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT
+ *          #MEDIA_STREAMER_ERROR_INVALID_OPERATION,\n
+ *          #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,\n
+ *          #MEDIA_STREAMER_ERROR_NOT_SUPPORTED,\n
+ *          #MEDIA_STREAMER_ERROR_CONNECTION_FAILED,\n
+ *          #MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT.\n
+ *          The @a streamer is the same object for which the callback was set.
  * @param[in] streamer   Media streamer handle
  * @param[in] error      The error that occurred in media steamer
  * @param[in] user_data  The user data passed from the code where
@@ -467,6 +468,7 @@ typedef void (*media_streamer_error_cb)(media_streamer_h streamer,
 /**
  * @brief Called when media streamer state is changed.
  * @since_tizen 3.0
+ * @remarks The @a streamer is the same object for which the callback was set.
  * @param[in] streamer        Media streamer handle
  * @param[in] previous_state  The previous state of the media streamer
  * @param[in] current_state   The current state of media streamer
@@ -485,7 +487,8 @@ typedef void (*media_streamer_state_changed_cb)(media_streamer_h streamer,
  * @details This callback will be invoked when the buffer level drops below the threshold of max size
  *          or no free space in custom source buffer.
  * @since_tizen 3.0
- * @remarks Callback can be applied only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
+ * @remarks This callback can be applied only to #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type node.\n
+ *          The @a src is the same object for which the callback was set.
  * @param[in] src       Media streamer source node handle
  * @param[in] status    Media streamer custom buffer status
  * @param[in] user_data The user data passed from the callback registration function
@@ -500,6 +503,7 @@ typedef void (*media_streamer_custom_buffer_status_cb)(media_streamer_node_h src
  * @brief Called when new data is available from custom sink.
  * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type node.
  * @since_tizen 3.0
+ * @remarks The @a sink is the same object for which the callback was set.
  * @param[in] sink      Media streamer sink node handle
  * @param[in] user_data The user data passed from the code where
  *                       media_streamer_sink_set_data_ready_cb() was invoked
@@ -515,6 +519,7 @@ typedef void (*media_streamer_sink_data_ready_cb)(media_streamer_node_h sink, vo
  * @brief  Called when the end-of-stream has been reached.
  * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type node.
  * @since_tizen 3.0
+ * @remarks The @a sink is the same object for which the callback was set.
  * @param[in] sink      Media streamer sink node handle
  * @param[in] user_data The user data passed from the code where
  *                       media_streamer_sink_set_eos_cb() was invoked
@@ -547,6 +552,8 @@ typedef void (*media_streamer_interrupted_cb)(media_streamer_interrupted_code_e
 /**
  * @brief Called when a source pad of a media streamer node is ready to provide decoded data.
  * @since_tizen 6.0
+ * @remarks The @a node is the same object for which the callback was set.\n
+ *          The @a src_pad_name and the @a media_type can be used only in the callback. To use outside, make a copy.
  * @param[in] node          Media streamer node handle
  * @param[in] src_pad_name  The source pad name that can give decoded data to another one
  * @param[in] media_type    The media type of the data from the given source pad such as 'video/x-raw', 'audio/x-raw', and so on
@@ -563,7 +570,9 @@ typedef void (*media_streamer_node_decoded_ready_cb)(media_streamer_node_h node,
  * @remarks Two types will be delivered with @a message which is a JSON string.\n
  *          One is for the remote session description and the other is for a new ICE candidate.\n
  *          For the remote session description, @a message will be {"sdp":{"type":"offer or answer","sdp":"..."}}.\n
- *          For the new ICE candidate, @a message will be {"ice":{"candidate":"..."}}.
+ *          For the new ICE candidate, @a message will be {"ice":{"candidate":"..."}}.\n
+ *          The @a webrtc is the same object for which the callback was set.\n
+ *          The @a message can be used only in the callback. To use outside, make a copy.
  * @param[in] webrtc     Media streamer WebRTC node handle
  * @param[in] message    The message to be passed to the remote peer over the signaling channel
  * @param[in] user_data  The user data passed from the callback registration function
@@ -574,13 +583,13 @@ typedef void (*media_streamer_webrtc_message_cb)(media_streamer_node_h webrtc, c
 
 /**
  * @brief Sets a error callback function to be invoked when an error occurs.
- * @details Following error codes can be delivered by error callback.
- *          #MEDIA_STREAMER_ERROR_INVALID_OPERATION,
- *          #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,
- *          #MEDIA_STREAMER_ERROR_NOT_SUPPORTED,
- *          #MEDIA_STREAMER_ERROR_CONNECTION_FAILED,
- *          #MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT
  * @since_tizen 3.0
+ * @remarks Following error codes can be delivered by error callback.\n
+ *          #MEDIA_STREAMER_ERROR_INVALID_OPERATION,\n
+ *          #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,\n
+ *          #MEDIA_STREAMER_ERROR_NOT_SUPPORTED,\n
+ *          #MEDIA_STREAMER_ERROR_CONNECTION_FAILED,\n
+ *          #MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT
  * @param[in] streamer  Media streamer handle
  * @param[in] callback  Callback function pointer
  * @param[in] user_data The user data passed from the code where

diff --git a/packaging/capi-media-streamer.spec b/packaging/capi-media-streamer.spec
index 1a52369..462321e 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.82
+Version:    0.1.83
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0