From: Doyoun Kang <doyoun.kang@samsung.com>
Date: Fri, 4 Oct 2024 10:30:56 +0000 (+0900)
Subject: Improve documentation
X-Git-Tag: accepted/tizen/9.0/unified/20241108.065622~6
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=56efa7da820a6849b19535e71ecaef38726eef87;p=platform%2Fcore%2Fapi%2Fefl-util.git

Improve documentation

Change-Id: Ib5b6d1040b24ec975ccae70ea56bcdc9df2fa8c0
---

diff --git a/doc/ui_efl_util_screenshot_doc.h b/doc/ui_efl_util_screenshot_doc.h
index 91f3fe1..c5c0165 100644
--- a/doc/ui_efl_util_screenshot_doc.h
+++ b/doc/ui_efl_util_screenshot_doc.h
@@ -28,8 +28,14 @@
  * @section CAPI_EFL_UTIL_SCREENSHOT_MODULE_OVERVIEW Overview
  * The EFL UTIL SCREENSHOT API provides functions to capture screenshot.
  * Client can get screenshot image by efl_util_screenshot_take_tbm_surface
- * API with tbm_surface handler.
+ * API with tbm_surface handler.<br>
  *
+ * To take a screenshot, use the following steps:<br>
+ * 1. Create the efl_util_screenshot_h handle<br>
+ * 2. Initialize the handle information using the efl_util_screenshot_initialize() function<br>
+ * 3. Call the efl_util_screenshot_take_tbm_surface() function with the argument efl_util_screenshot_h<br>
+ *    Then the captured screen data will be returned to tbm_surface_h handle<br>
+ * 4. If no longer needed, call the efl_util_screenshot_deinitialize() function to free the efl_util_screenshot_h<br>
  */
 
 #endif /* __TIZEN_UI_EFL_UTIL_SCREENSHOT_DOC_H__ */
diff --git a/doc/ui_efl_util_win_property_doc.h b/doc/ui_efl_util_win_property_doc.h
index 566bbeb..204b043 100644
--- a/doc/ui_efl_util_win_property_doc.h
+++ b/doc/ui_efl_util_win_property_doc.h
@@ -29,6 +29,18 @@
  * The EFL UTIL WINDOW PROPERTY API provides functions to set/get properties of windows
  * such as the notification level, the screen mode and the brightness.
  *
+ * @section CAPI_EFL_UTIL_WIN_PROPERTY_NOTIFICATION_LEVEL Notification Level
+ * Tizen windows have a layer hierarchy. Window layers are logical containers used to control the window stack order.<br>
+ * Among these, there is a notification layer for windows that need to appear above regular windows like emergency popups.<br>
+ * And the notification level is provided for layering between notification windows.<br>
+ * This works ONLY for NOTIFICATION type window.
+ *
+ * @section CAPI_EFL_UTIL_WIN_PROPERTY_SCREEN_MODE Screen Mode
+ * By setting the Screen Mode on a window, you can prevent the screen from being turned off automatically by the timer
+ * while the window is visible on the screen.
+ *
+ * @section CAPI_EFL_UTIL_WIN_PROPERTY_BRIGHTNESS Brightness
+ * By setting the Brightness on a window, you can change the brightness of the screen.
  */
 
 #endif /* __TIZEN_UI_EFL_UTIL_WIN_PROPERTY_DOC_H__ */