From: Youngwoo Cho <young222.cho@samsung.com>
Date: Thu, 19 Sep 2024 06:01:58 +0000 (+0900)
Subject: Improve doxygen description
X-Git-Tag: accepted/tizen/unified/20240926.050035^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fheads%2Ftizen_9.0;p=platform%2Fcore%2Fapi%2Fscreen-mirroring.git

Improve doxygen description

Change-Id: Ie741d3451c0928d413259649966ad1c999ae9180
Signed-off-by: Youngwoo Cho <young222.cho@samsung.com>
---

diff --git a/include/scmirroring_sink.h b/include/scmirroring_sink.h
index 6b3466d..11436d3 100644
--- a/include/scmirroring_sink.h
+++ b/include/scmirroring_sink.h
@@ -81,12 +81,13 @@ int scmirroring_sink_create(scmirroring_sink_h *scmirroring_sink);
 int scmirroring_sink_set_state_changed_cb(scmirroring_sink_h scmirroring_sink, scmirroring_sink_state_cb callback, void *user_data);
 
 /**
- * @brief Sets server IP and port.
+ * @brief Sets server IP address and port that mirroring sink will connect to.
+ * @details This function sets IP and port to be used for connecting with the server when executing @c scmirroring_sink_connect().
  *
  * @since_tizen 2.4
  *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
- * @param[in] ip The server IP address to connect to
+ * @param[in] ip The server IP address to connect to (IPv4 such as 127.0.0.1)
  * @param[in] port The server port to connect to
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -162,6 +163,8 @@ int scmirroring_sink_set_resolution(scmirroring_sink_h scmirroring_sink, int res
 
 /**
  * @brief Prepares the screen mirroring sink handle and allocates specific resources.
+ * @details This function constructs pipeline to prepare playing media
+ *
  * @since_tizen 2.4
  *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
@@ -176,11 +179,13 @@ int scmirroring_sink_set_resolution(scmirroring_sink_h scmirroring_sink, int res
  *
  * @pre Create a screen mirroring sink handle by calling scmirroring_sink_create().
  * @pre Register user callback by calling scmirroring_sink_set_state_changed_cb().
+ * @pre Set display to mirroring sink handle by calling scmirroring_sink_set_display().
  * @pre The screen mirroring state should be #SCMIRRORING_SINK_STATE_NULL
  * @post The screen mirroring state will be #SCMIRRORING_SINK_STATE_PREPARED
  *
  * @see scmirroring_sink_create()
  * @see scmirroring_sink_set_state_changed_cb()
+ * @see scmirroring_sink_set_display()
  */
 int scmirroring_sink_prepare(scmirroring_sink_h scmirroring_sink);
 
@@ -334,8 +339,8 @@ int scmirroring_sink_resume(scmirroring_sink_h scmirroring_sink);
 int scmirroring_sink_disconnect(scmirroring_sink_h scmirroring_sink);
 
 /**
- * @brief Unprepares screen mirroring.
- * @details This function unprepares screen mirroring, which closes specific resources.
+ * @brief Unprepares the screen mirroring sink handle and closes specific resources.
+ * @details This function releases and destroys pipeline and resources.
  *
  * @since_tizen 2.4
  *
@@ -361,7 +366,8 @@ int scmirroring_sink_disconnect(scmirroring_sink_h scmirroring_sink);
 int scmirroring_sink_unprepare(scmirroring_sink_h scmirroring_sink);
 
 /**
- * @brief Unregisters the callback function user registered.
+ * @brief Unregisters the state changed callback function that user registered.
+ * @details This function unregisters user callback and the state changed callback will not be called.
  *
  * @since_tizen 2.4
  *
diff --git a/include/scmirroring_type.h b/include/scmirroring_type.h
index 8294cad..707c727 100644
--- a/include/scmirroring_type.h
+++ b/include/scmirroring_type.h
@@ -40,7 +40,7 @@ extern "C" {
 typedef void *scmirroring_sink_h;
 
 /**
- * @brief Enumeration for screen mirroring error.
+ * @brief Enumeration to provide screen mirroring error information.
  * @since_tizen 2.4
  */
 typedef enum {
@@ -143,10 +143,11 @@ typedef enum {
 } scmirroring_av_transport_e;
 
 /**
- * @brief Called when each status is changed.
+ * @brief Called when state of screen mirroring sink handle is changed.
  * @since_tizen 2.4
  *
- * @details This callback is called for state and error of screen mirroring sink
+ * @details This callback is called for state and error of screen mirroring sink will be delivered together.
+ *          Error can be handled by return value of CAPIs. so there is no need to handle it here.
  *
  * @param[in] error     The error code
  * @param[in] state     The screen mirroring sink state