Revise descriptions 69/257469/4
authorSangchul Lee <sc11.lee@samsung.com>
Mon, 26 Apr 2021 10:28:36 +0000 (19:28 +0900)
committerSangchul Lee <sc11.lee@samsung.com>
Tue, 27 Apr 2021 04:18:47 +0000 (13:18 +0900)
Add missing descriptions for enums.
Remove redundant @param.

[Version] 0.1.158
[Issue Type] Doxygen

Change-Id: Id1a2703304d3682f636a3f291ec4809da3abefeb
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>
include/webrtc.h
packaging/capi-media-webrtc.spec

index 1f481487e4b2bfbba4e445980e7888c73917ed96..15c92e2d4c82e3c7ea18f4e510ba01952c79b877 100644 (file)
@@ -120,8 +120,8 @@ typedef enum {
  * @since_tizen 6.5
  */
 typedef enum {
-       WEBRTC_MEDIA_TYPE_AUDIO,
-       WEBRTC_MEDIA_TYPE_VIDEO,
+       WEBRTC_MEDIA_TYPE_AUDIO,   /**< Audio */
+       WEBRTC_MEDIA_TYPE_VIDEO,   /**< Video */
 } webrtc_media_type_e;
 
 /**
@@ -129,9 +129,9 @@ typedef enum {
  * @since_tizen 6.5
  */
 typedef enum {
-       WEBRTC_TRANSCEIVER_DIRECTION_SENDONLY,
-       WEBRTC_TRANSCEIVER_DIRECTION_RECVONLY,
-       WEBRTC_TRANSCEIVER_DIRECTION_SENDRECV,
+       WEBRTC_TRANSCEIVER_DIRECTION_SENDONLY,    /**< Send only */
+       WEBRTC_TRANSCEIVER_DIRECTION_RECVONLY,    /**< Receive only */
+       WEBRTC_TRANSCEIVER_DIRECTION_SENDRECV,    /**< Send and receive */
 } webrtc_transceiver_direction_e;
 
 /**
@@ -250,7 +250,6 @@ typedef void (*webrtc_track_added_cb)(webrtc_h webrtc, webrtc_media_type_e type,
  * @remarks The @a webrtc is the same object for which the callback was set.\nThe @a webrtc should not be released.\n
  *          Use media_packet_get_buffer_data_ptr() with @a packet to get the Gstreamer buffer pointer.
  *          The @a packet should be released by calling media_packet_destroy() after use.
- * @param[in] packet      Reference pointer to the media packet
  * @param[in] webrtc     WebRTC handle
  * @param[in] type       The media type
  * @param[in] track_id   The track id
index 8ee6e8045784f37cd77d90fe9da38f1791f65c4f..41625aed709c0ac4bfa8d2826e180423a7c00cb3 100644 (file)
@@ -1,6 +1,6 @@
 Name:       capi-media-webrtc
 Summary:    A WebRTC library in Tizen Native API
-Version:    0.1.157
+Version:    0.1.158
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0