fix Native API Reference error

Change-Id: I5bbf79ba38ff6eeca8da3a3fa1b5e26bea31f25c
Signed-off-by: Hyunil <hyunil46.park@samsung.com>

diff --git a/include/media_streamer.h b/include/media_streamer.h
index fa3d24b..6bd7c6a 100644 (file)
--- a/include/media_streamer.h
+++ b/include/media_streamer.h
@@ -180,7 +180,7 @@ typedef enum {
  * @details Index number of camera to activate.
  *          Data type is integer and default value is 0.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_CAMERA_ID "camera-id"
 
@@ -189,7 +189,7 @@ typedef enum {
  * @details Width for camera size to capture.
  *          Data type is integer and default value is 1600.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_CAPTURE_WIDTH "capture-width"
 
@@ -198,7 +198,7 @@ typedef enum {
  * @details Height for camera size to capture.
  *          Data type is integer and default value is 1200.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_CAPTURE_HEIGHT "capture-height"
 
@@ -207,7 +207,7 @@ typedef enum {
  * @details Whether to act as a live source.
  *          Data type is boolean and default value is false.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_IS_LIVE_STREAM "is-live"
 
@@ -216,7 +216,7 @@ typedef enum {
  * @details URI to read from
  *          Data type is string.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_URI "uri"
 
@@ -225,7 +225,7 @@ typedef enum {
  * @details Value of the User-Agent HTTP request header field.
  *          Data type is string.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_USER_AGENT "user-agent"
 
@@ -234,7 +234,7 @@ typedef enum {
  * @details The type of the push data stream.
  *          0:stream, 1:seekable, 2:random-access (default:0)
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_STREAM_TYPE "stream-type"
 
@@ -243,7 +243,7 @@ typedef enum {
  * @details The port to receive the packets from.
  *          Data type is integer and default value is 5004.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_PORT "port"
 
@@ -252,7 +252,7 @@ typedef enum {
  * @details The port to receive the video packets from.
  *          Data type is integer.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_VIDEO_IN_PORT "video_in_port"
 
@@ -261,7 +261,7 @@ typedef enum {
  * @details The port to receive the audio packets from.
  *          Data type is integer.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_AUDIO_IN_PORT "audio_in_port"
 
@@ -270,7 +270,7 @@ typedef enum {
  * @details The port to send the video packets to.
  *          Data type is integer.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_VIDEO_OUT_PORT "video_out_port"
 
@@ -279,7 +279,7 @@ typedef enum {
  * @details The port to send the audio packets to.
  *          Data type is integer.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_AUDIO_OUT_PORT "audio_out_port"
 
@@ -288,7 +288,7 @@ typedef enum {
  * @details IP address to send/receive packets for.
  *          Data type is string and default value is "0.0.0.0".
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_IP_ADDRESS "address"
 
@@ -298,7 +298,7 @@ typedef enum {
  *          ex) "hw:0,0", "hw:0,1"
  *          Data type is string and default value is "default".
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_AUDIO_DEVICE "audio_device"
 
@@ -307,7 +307,7 @@ typedef enum {
  * @details Synchronize on the clock
  *          Data type is boolean and default value is true.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_CLOCK_SYNCHRONIZED "sync"
 
@@ -317,7 +317,7 @@ typedef enum {
  *          0:none/1:rotate 90 degree/2:rotate 180 degree/3:rotate 270 degree
  *          Default value is 3(rotate 270 degree).
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_ROTATE "rotate"
 
@@ -327,7 +327,7 @@ typedef enum {
  *          0:none, 1:horizontal, 2:vertical, 3:both
  *          Default value is 0.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_FLIP "flip"
 
@@ -343,7 +343,7 @@ typedef enum {
  *          5:Custom ROI
  *          Default value is 0(Letter box).
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_DISPLAY_GEOMETRY_METHOD "display-geometry-method"
 
@@ -352,7 +352,7 @@ typedef enum {
  * @details It is a object to draw video frame on.
  *          Data type is Pointer.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_DISPLAY "display"
 
@@ -361,7 +361,7 @@ typedef enum {
  * @details Draws screen or blacks out.
  *          Data type is boolean and default value is true(visible).
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_VISIBLE "visible"
 
@@ -370,7 +370,7 @@ typedef enum {
  * @details The host/IP/Multicast group to send the packets to.
  *          Data type is string and default value is "localhost".
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_HOST "host"
 
@@ -379,7 +379,7 @@ typedef enum {
  * @details Path for writing playlist from
  *          Data type is string.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_SEGMENT_LOCATION "location"
 
@@ -387,7 +387,7 @@ typedef enum {
  * @brief Definition for playlist location parameter of adaptive sink node.
  * @details Path for writing playlist from. Data type is string.
  * @since_tizen 3.0
- * @see media_streamer_node_get_params
+ * @see media_streamer_node_get_params()
  */
 #define MEDIA_STREAMER_PARAM_PLAYLIST_LOCATION "playlist-location"
 
@@ -404,7 +404,7 @@ typedef enum {
  * @param[in] error      The error that occurred in media steamer
  * @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
+ *                       This data will be accessible from media_streamer_error_cb()
  * @pre Create media streamer handle by calling media_streamer_create() function
  * @see media_streamer_set_error_cb()
  * @see media_streamer_unset_error_cb()
@@ -420,7 +420,7 @@ typedef void (*media_streamer_error_cb)(media_streamer_h streamer,
  * @param[in] current_state   The current state of media 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
+ *                            This data will be accessible from media_streamer_state_changed_cb()
  * @pre Create media streamer handle by calling media_streamer_create() function
  * @see media_streamer_set_state_change_cb()
  * @see media_streamer_unset_state_change_cb()
@@ -433,7 +433,7 @@ 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 Callback can be applied only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
  * @param[in] node      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
@@ -446,12 +446,12 @@ typedef void (*media_streamer_custom_buffer_status_cb)(media_streamer_node_h nod
 
 /**
  * @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
+ * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
  * @since_tizen 3.0
  * @param[in] node      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
- *                       This data will be accessible from media_streamer_sink_data_ready_cb
+ *                       This data will be accessible from media_streamer_sink_data_ready_cb()
  * @pre media_streamer_sink_set_data_ready_cb()
  * @see MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
  * @see media_streamer_sink_set_data_ready_cb()
@@ -461,12 +461,12 @@ typedef void (*media_streamer_sink_data_ready_cb)(media_streamer_node_h node, 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
+ * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
  * @since_tizen 3.0
  * @param[in] node      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
- *                       This data will be accessible from media_streamer_sink_eos_cb
+ *                       This data will be accessible from media_streamer_sink_eos_cb()
  * @pre media_streamer_sink_set_eos_cb()
  * @see MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
  * @see media_streamer_sink_set_eos_cb()
@@ -505,7 +505,7 @@ typedef void (*media_streamer_interrupted_cb)(media_streamer_interrupted_code_e
  * @param[in] callback  Callback function pointer
  * @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
+ *                      This data will be accessible from media_streamer_error_cb()
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
@@ -538,7 +538,7 @@ int media_streamer_unset_error_cb(media_streamer_h streamer);
  * @param[in] callback  Callback function pointer
  * @param[in] user_data The user data passed from the code
  *                      where media_streamer_set_state_change_cb() was invoked
- *                      This data will be accessible from media_streamer_state_changed_cb
+ *                      This data will be accessible from media_streamer_state_changed_cb()
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
@@ -596,7 +596,7 @@ int media_streamer_unset_interrupted_cb(media_streamer_h streamer);
 
 /**
  * @brief Sets a callback function to be invoked when buffer underrun or overflow is occurred.
- * @details This function can be called only for MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
+ * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
  * @since_tizen 3.0
  * @remarks This function is used for media stream playback only.
  * @param[in] source    Media streamer source node handle
@@ -632,13 +632,13 @@ int media_streamer_src_unset_buffer_status_cb(media_streamer_node_h source);
 
 /**
  * @brief Sets a callback function to be called when the custom sink is ready for data processing.
- * @details This function can be called only for MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
+ * @details This function can be called only for #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
  * @since_tizen 3.0
  * @param[in] sink      Media streamer sink node handle
  * @param[in] callback  Callback function pointer
  * @param[in] user_data The user data passed from the code where
  *                       media_streamer_sink_set_data_ready_cb() was invoked
- *                       This data will be accessible from media_streamer_sink_data_ready_cb
+ *                       This data will be accessible from media_streamer_sink_data_ready_cb()
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
@@ -672,7 +672,7 @@ int media_streamer_sink_unset_data_ready_cb(media_streamer_node_h sink);
  * @param[in] callback  Callback function pointer
  * @param[in] user_data The user data passed from the code where
  *                       media_streamer_sink_set_eos_cb() was invoked.
- *                       This data will be accessible from media_streamer_sink_eos_cb
+ *                       This data will be accessible from media_streamer_sink_eos_cb()
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
@@ -716,7 +716,7 @@ int media_streamer_sink_unset_eos_cb(media_streamer_node_h sink);
 int media_streamer_create(media_streamer_h *streamer);
 
 /**
- * @brief Sets media streamer state to MEDIA_STREAMER_STATE_READY.
+ * @brief Sets media streamer state to #MEDIA_STREAMER_STATE_READY.
  * @since_tizen 3.0
  * @param[in] streamer     Media streamer handle
  * @return @c 0 on success,
@@ -725,7 +725,7 @@ int media_streamer_create(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 The media streamer state must be set to MEDIA_STREAMER_STATE_IDLE
+ * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE
  *      by calling media_streamer_create() or media_streamer_unprepare().
  * @pre At least one src and one sink should be added and linked in the streamer
  *      by calling media_streamer_node_create_src(), media_streamer_node_create_sink() and media_streamer_node_link().
@@ -736,7 +736,7 @@ int media_streamer_create(media_streamer_h *streamer);
 int media_streamer_prepare(media_streamer_h streamer);
 
 /**
- * @brief Sets media streamer state to MEDIA_STREAMER_STATE_IDLE.
+ * @brief Sets media streamer state to #MEDIA_STREAMER_STATE_IDLE.
  * @details The most recently used media is reset and no longer associated with the media streamer.
  * @since_tizen 3.0
  * @param[in] streamer     Media streamer handle
@@ -753,7 +753,7 @@ int media_streamer_prepare(media_streamer_h streamer);
 int media_streamer_unprepare(media_streamer_h streamer);
 
 /**
- * @brief Sets media streamer state to MEDIA_STREAMER_STATE_PLAYING.
+ * @brief Sets media streamer state to #MEDIA_STREAMER_STATE_PLAYING.
  * @details Start running the current streamer, or resumes it if paused.
  * @since_tizen 3.0
  * @param[in] streamer     Media streamer handle
@@ -815,7 +815,7 @@ int media_streamer_stop(media_streamer_h streamer);
  *          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
- *          after setting the streamer state to MEDIA_STREAMER_STATE_IDLE state.
+ *          after setting the streamer state to #MEDIA_STREAMER_STATE_IDLE state.
  * @param[in] streamer     Media streamer handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -871,8 +871,8 @@ int media_streamer_get_play_position(media_streamer_h streamer, int *time);
 /**
  * @brief Gets the total running time of the associated media.
  * @since_tizen 3.0
- * @remarks The streamer's src node type should be MEDIA_STREAMER_NODE_SRC_TYPE_FILE or MEDIA_STREAMER_NODE_SRC_TYPE_HTTP.
- *          If not, return value will be MEDIA_STREAMER_ERROR_NONE and duration will be -1.
+ * @remarks The streamer's src node type should be #MEDIA_STREAMER_NODE_SRC_TYPE_FILE or #MEDIA_STREAMER_NODE_SRC_TYPE_HTTP.
+ *          If not, return value will be #MEDIA_STREAMER_ERROR_NONE and duration will be -1.
  * @param[in]  streamer     Media streamer handle
  * @param[out] duration     The duration in milliseconds
  * @return @c 0 on success,
@@ -903,9 +903,6 @@ int media_streamer_get_state(media_streamer_h streamer, media_streamer_state_e *
 /**
  * @brief Creates media streamer source node.
  * @since_tizen 3.0
- * @privilege http://tizen.org/privilege/internet
- *            http://tizen.org/privilege/camera
- *            http://tizen.org/privilege/recorder
  * @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 src node handle the camera device.
  *          The recorder privilege(http://tizen.org/privilege/recorder) should be added if the src node handle the recorder device.
@@ -926,7 +923,7 @@ int media_streamer_node_create_src(media_streamer_node_src_type_e type, media_st
 
 /**
  * @brief Pushes packet into custom source node.
- * @details This function can be called only for MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM.
+ * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM.
  * @since_tizen 3.0
  * @param[in] src       Media streamer source node handle
  * @param[in] packet    Media packet handle
@@ -944,7 +941,6 @@ int media_streamer_node_push_packet(media_streamer_node_h src, media_packet_h pa
 /**
  * @brief Creates media streamer sink node.
  * @since_tizen 3.0
- * @privilege http://tizen.org/privilege/internet
  * @remarks The internet privilege(http://tizen.org/privilege/internet) should be added if any URIs are used to transmit the output data.
  *          You can release @a sink node using media_streamer_node_destroy()
  * @remarks If @a type is #MEDIA_STREAMER_NODE_SINK_TYPE_ADAPTIVE, the HTTP server will be started and the server will be able to transmit the output data to the other device.
@@ -965,7 +961,7 @@ int media_streamer_node_create_sink(media_streamer_node_sink_type_e type, media_
 
 /**
  * @brief Pulls packet from custom sink node.
- * @details This function can be called only for MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
+ * @details This function can be called only for #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
  * @since_tizen 3.0
  * @param[in] sink      Media streamer sink node handle
  * @param[out] packet   Media packet handle
@@ -983,11 +979,11 @@ int media_streamer_node_create_sink(media_streamer_node_sink_type_e type, media_
 int media_streamer_node_pull_packet(media_streamer_node_h sink, media_packet_h *packet);
 
 /**
- * @brief Creates media streamer node except MEDIA_STREAMER_NODE_TYPE_SRC and MEDIA_STREAMER_NODE_TYPE_SINK.
+ * @brief Creates media streamer node except #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
  * @details Creates node specific @a type with specific format of input
  *          and output data.
  * @since_tizen 3.0
- * @remarks The node type should not be MEDIA_STREAMER_NODE_TYPE_SRC and MEDIA_STREAMER_NODE_TYPE_SINK.
+ * @remarks The node type should not be #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
  *          To create src/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
  * @param[in]  type      Created node type
@@ -1048,7 +1044,7 @@ int media_streamer_node_destroy(media_streamer_node_h node);
 /**
  * @brief Removes media streamer node from streamer.
  * @since_tizen 3.0
- * @remarks To remove node without error posting, the state of streamer should be MEDIA_STREAMER_STATE_IDLE.
+ * @remarks To remove node without error posting, the state of streamer should be #MEDIA_STREAMER_STATE_IDLE.
  *          If the node is linked, it will be unlinked before removing.
  * @param[in] streamer    Media streamer handle
  * @param[in] node        Media streamer node handle
@@ -1158,8 +1154,6 @@ int media_streamer_node_get_pad_name(media_streamer_node_h node, char ***src_pad
  * @brief Sets parameters of node.
  * @details Many parameters can be set at one time all together by using bundle.
  * @since_tizen 3.0
- * @privilege http://tizen.org/privilege/mediastorage
- *            http://tizen.org/privilege/externalstorage
  * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.
  *          The externalstorage privilege(http://tizen.org/privilege/externalstorage) should be added if any video/audio files are written in the external storage devices.
  * @param[in] node        Media streamer node handle
@@ -1206,8 +1200,6 @@ int media_streamer_node_get_params(media_streamer_node_h node, bundle **param_li
  * @brief Sets single parameter of node.
  * @details Sets parameter one by one without creating param bundle.
  * @since_tizen 3.0
- * @privilege http://tizen.org/privilege/mediastorage
- *            http://tizen.org/privilege/externalstorage
  * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.
  *          The externalstorage privilege(http://tizen.org/privilege/externalstorage) should be added if any video/audio files are written in the external storage devices.
  * @param[in] node        Media streamer node handle