Fix api description for device_battery_get_info() 90/237490/6 accepted/tizen/unified/20200707.140922 submit/tizen/20200706.095902
authorHyotaek Shim <hyotaek.shim@samsung.com>
Wed, 1 Jul 2020 02:28:46 +0000 (11:28 +0900)
committerHyotaek Shim <hyotaek.shim@samsung.com>
Wed, 1 Jul 2020 02:45:10 +0000 (11:45 +0900)
Change-Id: Ie9e191a999d9c54134ec9507d78117c4299a0b37
Signed-off-by: Hyotaek Shim <hyotaek.shim@samsung.com>
include/battery-internal.h

index 053535697b946e7cf0ee4021dcb13d433ac94049..804b5dd551cd58c214bec9c768da56fa67c077d6 100644 (file)
@@ -51,7 +51,9 @@ struct battery_info {
 /**
  * @brief Gets the battery status..
  * @since_tizen 6.0
- * @param[out] battery status
+ * @param[out] info battery status information.\n
+ *                  The current_average is INT_MAX if battery hw does not provide current average.\n
+ *                  The voltage_average is INT_MAX if battery hw does not provide voltage average.
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #DEVICE_ERROR_NONE Successful