Fix doxygen - Add missing command @a to refer to member arguments

Invalid parameter description is also fixed.

[Version] 0.1.66
[Issue Type] Doxygen

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

diff --git a/include/media_streamer.h b/include/media_streamer.h
index 3cb4c5e..ed9ed4e 100644 (file)
--- a/include/media_streamer.h
+++ b/include/media_streamer.h
@@ -540,7 +540,7 @@ 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
- * @param[in] webrtc        Media streamer node handle
+ * @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
  * @param[in] user_data     The user data passed from the callback registration function
@@ -553,10 +553,10 @@ typedef void (*media_streamer_node_decoded_ready_cb)(media_streamer_node_h node,
 /**
  * @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 a JSON string.
+ * @remarks Two types will be delivered with @a 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":"..."}}.
+ *          For the remote session description, @a message will be {"sdp":{"type":"offer or answer","sdp":"..."}}.
+ *          For the new ICE candidate, @a message will be {"ice":{"candidate":"..."}}.
  * @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
@@ -1325,9 +1325,9 @@ int media_streamer_node_get_param(media_streamer_node_h node,
                                        const char *param_name, char **param_value);
 
 /**
- * @brief Sets a callback function to be invoked when a source pad of @ node is ready to give decoded data.
- * @remarks The available type of @a node for this function is #MEDIA_STREAMER_NODE_TYPE_WEBRTC.
+ * @brief Sets a callback function to be invoked when a source pad of @a node is ready to give decoded data.
  * @since_tizen 6.0
+ * @remarks The available type of @a node for this function is #MEDIA_STREAMER_NODE_TYPE_WEBRTC.
  * @param[in] node      Media streamer node handle
  * @param[in] callback  The decoded ready callback function to register
  * @param[in] user_data The user data to be passed to the callback function
@@ -1376,7 +1376,7 @@ int media_streamer_webrtc_node_set_message_cb(media_streamer_node_h webrtc, medi
 /**
  * @brief Unsets the WebRTC message callback function.
  * @since_tizen 6.0
- * @param[in] src    Media streamer WebRTC node handle
+ * @param[in] webrtc    Media streamer WebRTC node handle
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful

diff --git a/packaging/capi-media-streamer.spec b/packaging/capi-media-streamer.spec
index 06e4351..766f7b9 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.65
+Version:    0.1.66
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0