From: Sangchul Lee <sc11.lee@samsung.com>
Date: Wed, 29 Nov 2023 03:46:19 +0000 (+0900)
Subject: webrtc_internal: Fix doxygen
X-Git-Tag: accepted/tizen/7.0/unified/20231204.175248~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b3a2acf2da60e449e69998b0cbda944db64f80e2;p=platform%2Fcore%2Fapi%2Fwebrtc.git

webrtc_internal: Fix doxygen

Missing @internal tag is added.
An error type that does not occur is removed from the description.
@Remarks for releasing handle are added.
Mis-typed function name is fixed.

[Version] 0.3.296
[Issue Type] Doxygen

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

diff --git a/include/webrtc_internal.h b/include/webrtc_internal.h
index b19bb12c..00e446e1 100644
--- a/include/webrtc_internal.h
+++ b/include/webrtc_internal.h
@@ -170,7 +170,8 @@ int webrtc_set_ecore_wl_display(webrtc_h webrtc, unsigned int track_id, void *ec
 int webrtc_set_display_surface_id(webrtc_h webrtc, unsigned int track_id, int surface_id, int x, int y, int width, int height);
 
 /**
- * @brief Sets a display QoS.
+ * @internal
+ * @brief Sets a display quality of service.
  * @since_tizen 7.0
  * @remarks Call this function within webrtc_track_added_cb(), otherwise #WEBRTC_ERROR_INVALID_OPERATION will be returned.\n
  *          If webrtc_set_encoded_video_frame_cb() has been called, it will return #WEBRTC_ERROR_INVALID_OPERATION.\n
@@ -305,7 +306,6 @@ int webrtc_media_source_set_video_loopback_to_ecore_wl(webrtc_h webrtc, unsigned
  *         otherwise a negative error value
  * @retval #WEBRTC_ERROR_NONE    Successful
  * @retval #WEBRTC_ERROR_NOT_SUPPORTED Not supported
- * @retval #WEBRTC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state
@@ -396,6 +396,7 @@ int webrtc_get_rtp_packet_drop_probability(webrtc_h webrtc, bool sender, float *
  * @internal
  * @brief Creates a signaling server for private network.
  * @since_tizen 6.5
+ * @remarks The @a server should be released using webrtc_signaling_server_destroy().
  * @param[in] port           The port number
  * @param[out] server        Signaling server handle
  * @return @c 0 on success,
@@ -460,6 +461,7 @@ int webrtc_signaling_server_destroy(webrtc_signaling_server_h server);
  * @internal
  * @brief Connects to a signaling server for private network.
  * @since_tizen 6.5
+ * @remarks The @a client should be released using webrtc_signaling_disconnect().
  * @param[in] server_ip      The signaling server IP address
  * @param[in] port           The port number
  * @param[in] callback       Callback function pointer
@@ -473,7 +475,7 @@ int webrtc_signaling_server_destroy(webrtc_signaling_server_h server);
  * @see webrtc_signaling_get_id()
  * @see webrtc_signaling_request_session()
  * @see webrtc_signaling_send_message()
- * @see webrtc_signaling_disconnect_server()
+ * @see webrtc_signaling_disconnect()
  */
 int webrtc_signaling_connect(const char *server_ip, int port, webrtc_signaling_message_cb callback, void *user_data, webrtc_signaling_client_h *client);
 
diff --git a/packaging/capi-media-webrtc.spec b/packaging/capi-media-webrtc.spec
index 25d930e6..0f553699 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.3.295
+Version:    0.3.296
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0