Revise descriptions

 1. fix invalid state information of @post of media_streamer_pause().
   - #MEDIA_STREAMER_STATE_READY -> #MEDIA_STREAMER_STATE_PAUSED
 2. fix grammar errors.
   - it have to be free -> it has to be freed
 3. remove redundant 'function' word after mentioning func_xxx().
 4. add punctuation mark when after finishing each @pre, @post
    doxygen command.

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

diff --git a/include/media_streamer.h b/include/media_streamer.h
index 08442d5..b1b3fa9 100644 (file)
--- a/include/media_streamer.h
+++ b/include/media_streamer.h
@@ -156,7 +156,7 @@ typedef enum {
 } media_streamer_error_e;
 
 /**
- * @brief Enumeration of media streamer buffer status of custom source.
+ * @brief Enumeration for media streamer buffer status of custom source.
  *
  * @since_tizen 3.0
  */
@@ -350,7 +350,7 @@ typedef enum {
 /**
  * @brief Definition for display parameter of sink node.
  * @details It is a object to draw video frame on.
- *          Data type is Pointer.
+ *          Data type is pointer.
  * @since_tizen 3.0
  * @see media_streamer_node_get_params()
  */
@@ -416,7 +416,7 @@ typedef enum {
  * @param[in] user_data  The user data passed from the code where
  *                       media_streamer_set_error_cb() was invoked
  *                       This data will be accessible from media_streamer_error_cb()
- * @pre Create media streamer handle by calling media_streamer_create() function
+ * @pre Create media streamer handle by calling media_streamer_create().
  * @see media_streamer_set_error_cb()
  * @see media_streamer_unset_error_cb()
  */
@@ -432,7 +432,7 @@ typedef void (*media_streamer_error_cb)(media_streamer_h streamer,
  * @param[in] user_data       The user data passed from the code where
  *                            media_streamer_set_state_changed_cb() was invoked
  *                            This data will be accessible from media_streamer_state_changed_cb()
- * @pre Create media streamer handle by calling media_streamer_create() function
+ * @pre Create media streamer handle by calling media_streamer_create().
  * @see media_streamer_set_state_change_cb()
  * @see media_streamer_unset_state_change_cb()
  */
@@ -522,7 +522,7 @@ typedef void (*media_streamer_interrupted_cb)(media_streamer_interrupted_code_e
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a media streamer handle by calling media_streamer_create() function
+ * @pre Create a media streamer handle by calling media_streamer_create().
  * @post media_streamer_error_cb() will be invoked.
  * @see media_streamer_unset_error_cb()
  * @see media_streamer_error_cb()
@@ -555,7 +555,7 @@ int media_streamer_unset_error_cb(media_streamer_h streamer);
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a media streamer handle by calling media_streamer_create() function
+ * @pre Create a media streamer handle by calling media_streamer_create().
  * @post media_streamer_state_changed_cb() will be invoked.
  * @see media_streamer_unset_state_change_cb()
  * @see media_streamer_state_changed_cb()
@@ -620,8 +620,8 @@ int media_streamer_unset_interrupted_cb(media_streamer_h streamer);
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a media streamer source node handle by calling media_streamer_node_create_src() function
- * @pre Add created media streamer source node to media streamer by calling media_streamer_node_add() function
+ * @pre Create a media streamer source node handle by calling media_streamer_node_create_src().
+ * @pre Add created media streamer source node to media streamer by calling media_streamer_node_add().
  * @post media_streamer_custom_buffer_status_cb() will be invoked.
  * @see media_streamer_src_unset_buffer_status_cb()
  * @see media_streamer_custom_buffer_status_cb()
@@ -655,8 +655,8 @@ int media_streamer_src_unset_buffer_status_cb(media_streamer_node_h source);
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a media streamer sink handle by calling media_streamer_node_create_sink() function
- * @pre Add created media streamer sink node to media streamer by calling media_streamer_node_add() function
+ * @pre Create a media streamer sink handle by calling media_streamer_node_create_sink().
+ * @pre Add created media streamer sink node to media streamer by calling media_streamer_node_add().
  * @post media_streamer_sink_data_ready_cb() will be invoked.
  * @see media_streamer_sink_unset_data_ready_cb()
  * @see media_streamer_sink_data_ready_cb()
@@ -689,8 +689,8 @@ int media_streamer_sink_unset_data_ready_cb(media_streamer_node_h sink);
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a media streamer sink handle by calling media_streamer_node_create_sink() function
- * @pre Add created media streamer sink node to media streamer by calling media_streamer_node_add() function
+ * @pre Create a media streamer sink handle by calling media_streamer_node_create_sink().
+ * @pre Add created media streamer sink node to media streamer by calling media_streamer_node_add().
  * @post media_streamer_sink_eos_cb() will be invoked.
  * @see media_streamer_sink_unset_eos_cb()
  * @see media_streamer_sink_eos_cb()
@@ -794,7 +794,7 @@ int media_streamer_play(media_streamer_h streamer);
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_PLAYING.
- * @post The media streamer state will be #MEDIA_STREAMER_STATE_READY.
+ * @post The media streamer state will be #MEDIA_STREAMER_STATE_PAUSED.
  * @see media_streamer_create()
  * @see media_streamer_play()
  */
@@ -825,7 +825,7 @@ int media_streamer_stop(media_streamer_h streamer);
  * @remarks Nodes in streamer will be removed automatically.
  *          Don't need to remove nodes by calling media_streamer_node_remove().
  *          If you want to change the node without destroying streamer handle,
- *          you can call the media_streamer_node_remove() function
+ *          you can call the media_streamer_node_remove().
  *          after setting the streamer state to #MEDIA_STREAMER_STATE_IDLE state.
  * @param[in] streamer     Media streamer handle
  * @return @c 0 on success,
@@ -834,7 +834,7 @@ int media_streamer_stop(media_streamer_h streamer);
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a media streamer handle by calling media_streamer_create() function
+ * @pre Create a media streamer handle by calling media_streamer_create().
  * @post The media streamer state will be #MEDIA_STREAMER_STATE_NONE.
  * @see media_streamer_create()
  */
@@ -906,7 +906,7 @@ int media_streamer_get_duration(media_streamer_h streamer, int *duration);
  * @retval #MEDIA_STREAMER_ERROR_NONE    Successful
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a media streamer handle by calling media_streamer_create() function
+ * @pre Create a media streamer handle by calling media_streamer_create().
  * @see #media_streamer_state_e
  */
 int media_streamer_get_state(media_streamer_h streamer, media_streamer_state_e *state);
@@ -917,7 +917,7 @@ int media_streamer_get_state(media_streamer_h streamer, media_streamer_state_e *
  * @remarks The internet privilege(%http://tizen.org/privilege/internet) should be added if any URIs are used to play from network.
  *          The camera privilege(%http://tizen.org/privilege/camera) should be added if the source node handles the camera device.
  *          The recorder privilege(%http://tizen.org/privilege/recorder) should be added if the source node handles the recorder device.
- *          You can release source node using media_streamer_node_destroy() function.
+ *          You can release source node using media_streamer_node_destroy().
  * @param[in]  type     Media streamer source node type
  * @param[out] source   Media streamer source node handle
  * @return @c 0 on success,
@@ -943,7 +943,7 @@ int media_streamer_node_create_src(media_streamer_node_src_type_e type, media_st
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a source node handle by calling media_streamer_node_create_src() function
+ * @pre Create a source node handle by calling media_streamer_node_create_src().
  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE at least.
  * @see #media_packet_h
  */
@@ -982,8 +982,8 @@ int media_streamer_node_create_sink(media_streamer_node_sink_type_e type, media_
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a sink node handle by calling media_streamer_node_create_sink() function
- * @pre Set media_streamer_sink_data_ready_cb by calling media_streamer_sink_set_data_ready_cb() function.
+ * @pre Create a sink node handle by calling media_streamer_node_create_sink().
+ * @pre Set media_streamer_sink_data_ready_cb by calling media_streamer_sink_set_data_ready_cb().
  * @see #media_packet_h
  * @see media_streamer_node_create_sink()
  */
@@ -996,7 +996,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.
- *          You can release @a node using media_streamer_node_destroy() function
+ *          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
  * @param[in]  out_fmt   Media format handle for output data
@@ -1024,8 +1024,8 @@ int media_streamer_node_create(media_streamer_node_type_e type, media_format_h i
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create media streamer handle by calling media_streamer_create() function
- * @pre Create node handle by calling media_streamer_node_create() function
+ * @pre Create media streamer handle by calling media_streamer_create().
+ * @pre Create node handle by calling media_streamer_node_create().
  * @see media_streamer_create()
  * @see media_streamer_node_create()
  * @see media_streamer_node_create_src()
@@ -1043,8 +1043,8 @@ int media_streamer_node_add(media_streamer_h streamer, media_streamer_node_h nod
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create node handle by calling media_streamer_node_create() function
- * @pre If the node was added to media streamer, it have to be removed by calling media_streamer_node_remove() function
+ * @pre Create node handle by calling media_streamer_node_create().
+ * @pre If the node was added to media streamer, it has to be removed by calling media_streamer_node_remove().
  * @see media_streamer_node_create()
  * @see media_streamer_node_create_src()
  * @see media_streamer_node_create_sink()
@@ -1065,7 +1065,7 @@ int media_streamer_node_destroy(media_streamer_node_h node);
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Add node to streamer by calling media_streamer_node_add() function
+ * @pre Add node to streamer by calling media_streamer_node_add().
  * @see media_streamer_node_add()
  */
 int media_streamer_node_remove(media_streamer_h streamer, media_streamer_node_h node);
@@ -1092,8 +1092,8 @@ int media_streamer_node_remove(media_streamer_h streamer, media_streamer_node_h
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
  * @pre Create a source node and a destination node handles
- *      by calling media_streamer_node_create() function
- *      and add the nodes into streamer by calling media_streamer_node_add() function.
+ *      by calling media_streamer_node_create()
+ *      and add the nodes into streamer by calling media_streamer_node_add().
  * @see media_streamer_node_create()
  * @see media_streamer_node_add()
  */
@@ -1112,8 +1112,8 @@ int media_streamer_node_link(media_streamer_node_h src_node, const char *src_pad
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a node handle by calling media_streamer_node_createxxx() function
- * @pre Get pad name by calling media_streamer_node_get_pad_name() function
+ * @pre Create a node handle by calling media_streamer_node_createxxx().
+ * @pre Get pad name by calling media_streamer_node_get_pad_name().
  * @see #media_format_h
  */
 int media_streamer_node_set_pad_format(media_streamer_node_h node, const char *pad_name, media_format_h fmt);
@@ -1130,8 +1130,8 @@ int media_streamer_node_set_pad_format(media_streamer_node_h node, const char *p
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a node handle by calling media_streamer_node_createxxx() function
- * @pre Get pad name by calling media_streamer_node_get_pad_name() function
+ * @pre Create a node handle by calling media_streamer_node_createxxx().
+ * @pre Get pad name by calling media_streamer_node_get_pad_name().
  * @see #media_format_h
  */
 int media_streamer_node_get_pad_format(media_streamer_node_h node, const char *pad_name, media_format_h *fmt);
@@ -1139,7 +1139,7 @@ int media_streamer_node_get_pad_format(media_streamer_node_h node, const char *p
 /**
  * @brief Gets name of node pads.
  * @since_tizen 3.0
- * @remarks After using the src_pad_name and sink_pad_name, it have to be free.
+ * @remarks After using the src_pad_name and sink_pad_name, it has to be freed.
  *          src_pad_name or sink_pad_name can be null according to the node type.
  *          In case of source type node, sink_pad_name will be null.
  *          In case of sink type node, src_pad_name will be null.
@@ -1153,7 +1153,7 @@ int media_streamer_node_get_pad_format(media_streamer_node_h node, const char *p
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a node handle by calling media_streamer_node_createxxx() function
+ * @pre Create a node handle by calling media_streamer_node_createxxx().
  * @see media_streamer_node_create()
  * @see media_streamer_node_create_src()
  * @see media_streamer_node_create_sink()
@@ -1176,8 +1176,8 @@ int media_streamer_node_get_pad_name(media_streamer_node_h node, char ***src_pad
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
- * @pre Create a node handle by calling media_streamer_node_createXXX() function.
- * @pre Get param list to set by calling media_streamer_node_get_params() function.
+ * @pre Create a node handle by calling media_streamer_node_createXXX().
+ * @pre Get param list to set by calling media_streamer_node_get_params().
  * @see media_streamer_node_create()
  * @see media_streamer_node_create_src()
  * @see media_streamer_node_create_sink()
@@ -1187,7 +1187,7 @@ int media_streamer_node_set_params(media_streamer_node_h node, bundle *param_lis
 /**
  * @brief Gets node parameter list.
  * @since_tizen 3.0
- * @remarks After using param_list, it have to be free by calling bundle_free() in bundle.h
+ * @remarks After using param_list, it has to be freed by calling bundle_free() in bundle.h
  *          Refer to the "Parameter information of node" in this file to get info.
  * @param[in]  node         Media streamer node handle
  * @param[out] param_list   Key value array of media streamer node parameters
@@ -1197,8 +1197,8 @@ int media_streamer_node_set_params(media_streamer_node_h node, bundle *param_lis
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a node handle by calling media_streamer_node_createXXX() function
- * @post Set params which are needed to set by calling media_streamer_node_set_params() or media_streamer_node_set_param() function.
+ * @pre Create a node handle by calling media_streamer_node_createXXX().
+ * @post Set params which are needed to set by calling media_streamer_node_set_params() or media_streamer_node_set_param().
  * @see media_streamer_node_create()
  * @see media_streamer_node_create_src()
  * @see media_streamer_node_create_sink()
@@ -1223,8 +1223,8 @@ int media_streamer_node_get_params(media_streamer_node_h node, bundle **param_li
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
- * @pre Create a node handle by calling media_streamer_node_createXXX() function.
- * @pre Get param list to set by calling media_streamer_node_get_params() function.
+ * @pre Create a node handle by calling media_streamer_node_createXXX().
+ * @pre Get param list to set by calling media_streamer_node_get_params().
  * @see media_streamer_node_create()
  * @see media_streamer_node_create_src()
  * @see media_streamer_node_create_sink()
@@ -1248,8 +1248,8 @@ int media_streamer_node_set_param(media_streamer_node_h node,
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a node handle by calling media_streamer_node_createXXX() function.
- * @pre Get param list to know the param name by calling media_streamer_node_get_params() function.
+ * @pre Create a node handle by calling media_streamer_node_createXXX().
+ * @pre Get param list to know the param name by calling media_streamer_node_get_params().
  * @see media_streamer_node_create()
  * @see media_streamer_node_create_src()
  * @see media_streamer_node_create_sink()