From: Sangchul Lee <sc11.lee@samsung.com>
Date: Thu, 21 Jan 2021 08:19:36 +0000 (+0900)
Subject: webrtc: Improve description
X-Git-Tag: submit/tizen/20210729.023123~156
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6b4d9b855d1a1acfe4a9cec049f353496fcdc02a;p=platform%2Fcore%2Fapi%2Fwebrtc.git

webrtc: Improve description

Fix wrong sentence in webrtc_start().

Add precondition to webrtc_set_transceiver_direction() and
webrtc_get_transceiver_direction().

[Version] 0.1.85
[Issue Type] Doxygen

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

diff --git a/include/webrtc.h b/include/webrtc.h
index b2e5f25c..1cef52b6 100644
--- a/include/webrtc.h
+++ b/include/webrtc.h
@@ -392,7 +392,7 @@ int webrtc_create(webrtc_h *webrtc);
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state
  * @pre webrtc_ice_candidate_cb() must be set by calling webrtc_set_ice_candidate_cb().
- * @pre webrtc_media_packet_source_set_format() must be set by calling webrtc_set_ice_candidate_cb().
+ * @pre webrtc_media_packet_source_set_format() must be called if @a webrtc has a media packet source.
  * @pre @a webrtc state must be set to #WEBRTC_STATE_IDLE.
  * @post @a webrtc state will be #WEBRTC_STATE_NEGOTIATING.
  * @see webrtc_create()
@@ -564,6 +564,7 @@ int webrtc_media_packet_source_push_packet(webrtc_h webrtc, unsigned int source_
  * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @pre Add media source to @a webrtc to get @a source_id by calling webrtc_add_media_source().
+ * @pre webrtc_media_packet_source_set_format() must be called if @a source_id is a media source of #WEBRTC_MEDIA_SOURCE_TYPE_MEDIA_PACKET.
  * @see webrtc_set_transceiver_direction()
  */
 int webrtc_get_transceiver_direction(webrtc_h webrtc, unsigned int source_id, webrtc_media_type_e media_type, webrtc_transceiver_direction_e *direction);
@@ -582,6 +583,7 @@ int webrtc_get_transceiver_direction(webrtc_h webrtc, unsigned int source_id, we
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state
  * @pre Add media source to @a webrtc to get @a source_id by calling webrtc_add_media_source().
+ * @pre webrtc_media_packet_source_set_format() must be called if @a source_id is a media source of #WEBRTC_MEDIA_SOURCE_TYPE_MEDIA_PACKET.
  * @pre @a webrtc state must be set to #WEBRTC_STATE_IDLE.
  * @see webrtc_get_transceiver_direction()
  */
diff --git a/packaging/capi-media-webrtc.spec b/packaging/capi-media-webrtc.spec
index 198c7725..2eeabf32 100644
--- 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.1.84
+Version:    0.1.85
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0