Revise doxygen

FPS is mentioned to functions regarding video framerate.
Post command regarding error callback is described in case of
failure on sending data via data channel.

[Version] 0.3.50
[Issue Type] Doxygen

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

diff --git a/include/webrtc.h b/include/webrtc.h
index 28827d40deeb14df0ebde570feb9903d55139f90..19f4c0ba7b19df70f254cbd9b70f1a01c3325de4 100644 (file)
--- a/include/webrtc.h
+++ b/include/webrtc.h
@@ -958,7 +958,7 @@ int webrtc_media_source_set_video_resolution(webrtc_h webrtc, unsigned int sourc
 int webrtc_media_source_get_video_resolution(webrtc_h webrtc, unsigned int source_id, int *width, int *height);
 
 /**
- * @brief Sets a video source frame rate.
+ * @brief Sets a video source frame rate, also known as FPS.
  * @details The following media source types contain video:\n
  *          #WEBRTC_MEDIA_SOURCE_TYPE_VIDEOTEST\n
  *          #WEBRTC_MEDIA_SOURCE_TYPE_CAMERA\n
@@ -979,7 +979,7 @@ int webrtc_media_source_get_video_resolution(webrtc_h webrtc, unsigned int sourc
 int webrtc_media_source_set_video_framerate(webrtc_h webrtc, unsigned int source_id, int framerate);
 
 /**
- * @brief Gets the video source frame rate.
+ * @brief Gets the video source frame rate, also known as FPS.
  * @details The following media source types contain video:\n
  *          #WEBRTC_MEDIA_SOURCE_TYPE_VIDEOTEST\n
  *          #WEBRTC_MEDIA_SOURCE_TYPE_CAMERA\n
@@ -2244,6 +2244,7 @@ int webrtc_data_channel_unset_close_cb(webrtc_data_channel_h channel);
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state
  * @pre @a channel should be opened before calling this function.
+ * @post webrtc_data_channel_error_cb() will be invoked if this function fails.
  * @see webrtc_data_channel_open_cb()
  * @see webrtc_data_channel_send_bytes()
  */
@@ -2262,6 +2263,7 @@ int webrtc_data_channel_send_string(webrtc_data_channel_h channel, const char *s
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state
  * @pre @a channel should be opened before calling this function.
+ * @post webrtc_data_channel_error_cb() will be invoked if this function fails.
  * @see webrtc_data_channel_open_cb()
  * @see webrtc_data_channel_send_string()
  */

diff --git a/packaging/capi-media-webrtc.spec b/packaging/capi-media-webrtc.spec
index fce90251cf6198b55ff050c3022677cf02d0ca5e..e22237e9b70ec88b91e67dad53e50685dba90146 100644 (file)
--- a/packaging/capi-media-webrtc.spec
+++ b/packaging/capi-media-webrtc.spec
@@ -1,6 +1,6 @@
 Name:       capi-media-webrtc
 Summary:    A WebRTC library in Tizen Native API
-Version:    0.3.49
+Version:    0.3.50
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0