From: Youngjae Cho <y0.cho@samsung.com>
Date: Thu, 3 Mar 2022 07:57:13 +0000 (+0900)
Subject: display: complement description for brightness API
X-Git-Tag: accepted/tizen/unified/20220310.120927^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F27%2F271927%2F4;p=platform%2Fcore%2Fapi%2Fdevice.git

display: complement description for brightness API

Change-Id: Ibd53f488e3d6333b87e39cedca55e8dca4026496
Signed-off-by: Youngjae Cho <y0.cho@samsung.com>
---

diff --git a/include/display.h b/include/display.h
index 5d1502a..7c93b71 100644
--- a/include/display.h
+++ b/include/display.h
@@ -59,7 +59,8 @@ int device_display_get_numbers(int *device_number);
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/display
- * @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display
+ * @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display \n
+ *          or when the display HW module (e.g., plug-in touchscreen) is detached.
  * @param[in] display_index The index of the display \n
  *                          It can be greater than or equal to @c 0 and less than the number of displays returned by device_display_get_numbers(). \n
  *                          The index zero is always assigned to the main display
@@ -83,7 +84,8 @@ int device_display_get_max_brightness(int display_index, int *max_brightness);
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/display
- * @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display
+ * @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display \n
+ *          or when the display HW module (e.g., plug-in touchscreen) is detached.
  * @param[in] display_index The index of the display \n
  *                          It can be greater than or equal to @c 0 and less than the number of displays returned by device_display_get_numbers(). \n
  *                          The index zero is always assigned to the main display
@@ -107,7 +109,8 @@ int device_display_get_brightness(int display_index, int *brightness);
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/display
- * @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display
+ * @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display \n
+ *          or when the display HW module (e.g., plug-in touchscreen) is detached.
  * @param[in] display_index The index of the display \n
  *                          It can be greater than or equal to @c 0 and less than the number of displays returned by device_display_get_numbers(). \n
  *                          The index zero is always assigned to the main display