Revise description

webrtc_doc.h
 - Fix invalid information

webrtc.h
 - Add @remarks to callback function prototypes

[Version] 0.3.79
[Issue Type] Doxygen

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

diff --git a/doc/webrtc_doc.h b/doc/webrtc_doc.h
index 60f080b59d995d60dd4dfc7030e03d9bab65423e..06d348d656571589f6a743a4693d6eef462beb4d 100644 (file)
--- a/doc/webrtc_doc.h
+++ b/doc/webrtc_doc.h
@@ -75,7 +75,7 @@
  *    <td> webrtc_stop() </td>
  *    <td> NEGOTIATING/PLAYING </td>
  *    <td> IDLE </td>
- *    <td> SYNC </td>
+ *    <td> ASYNC </td>
  * </tr>
  * <tr>
  *    <td> webrtc_set_remote_description() </td>

diff --git a/include/webrtc.h b/include/webrtc.h
index dbf3f1de3001d3641353b8fac2b925fa7a18259c..aeece6b47891466e1e3f6abed11cb58859a2f3a1 100644 (file)
--- a/include/webrtc.h
+++ b/include/webrtc.h
@@ -488,7 +488,8 @@ typedef void (*webrtc_state_changed_cb)(webrtc_h webrtc, webrtc_state_e previous
  * @remarks The @a webrtc is the same object for which the callback was set.\n
  *          The @a webrtc should not be released.\n
  *          @a description is a JSON string.\n
- *          It will be {"sdp":{"type":"offer or answer","sdp":"..."}}.
+ *          It will be {"sdp":{"type":"offer or answer","sdp":"..."}}.\n
+ *          The @a description can be used only in the callback. To use outside, make a copy.
  * @param[in] webrtc       WebRTC handle
  * @param[in] description  The session description
  * @param[in] user_data    The user data passed from the callback registration function
@@ -555,6 +556,7 @@ typedef void (*webrtc_ice_connection_state_change_cb)(webrtc_h webrtc, webrtc_ic
 /**
  * @brief Called iteratively to inform all the TURN server URLs.
  * @since_tizen 6.5
+ * @remarks The @a turn_server can be used only in the callback. To use outside, make a copy.
  * @param[in] turn_server  The TURN server URL
  * @param[in] user_data    The user data passed from the callback registration function
  * @return @c true to continue with the next iteration of the loop,
@@ -579,7 +581,8 @@ typedef void (*webrtc_negotiation_needed_cb)(webrtc_h webrtc, void *user_data);
  * @brief Called when the WebRTC needs to send the ICE candidate message to the remote peer through the signaling channel.
  * @since_tizen 6.5
  * @remarks The @a webrtc is the same object for which the callback was set.\n
- *          The @a webrtc should not be released.
+ *          The @a webrtc should not be released.\n
+ *          The @a candidate can be used only in the callback. To use outside, make a copy.
  * @param[in] webrtc     WebRTC handle
  * @param[in] candidate  The ICE candidate message
  * @param[in] user_data  The user data passed from the callback registration function
@@ -775,6 +778,7 @@ typedef void (*webrtc_data_channel_buffered_amount_low_cb)(webrtc_data_channel_h
 /**
  * @brief Called iteratively to inform about a statistics property.
  * @since_tizen 7.0
+ * @remarks The @a prop_info can be used only in the callback. To use outside, make a copy.
  * @param[in] type       The statistics type
  * @param[in] prop_info  The statistics property information
  * @param[in] user_data  The user data passed from the callback registration function

diff --git a/packaging/capi-media-webrtc.spec b/packaging/capi-media-webrtc.spec
index cbed9abd8903f73f7786d7405072ebb89438e8b4..504bc4e3a58d79ec1d4dde2ad71bfe88df71b305 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.78
+Version:    0.3.79
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0