added remarks & see section in API description banner

Change-Id: I5b527cbf5f2868774e25f7e044dd4d3c8ddd6a86
Signed-off-by: Abhishek Vijay <abhishek.v@samsung.com>

diff --git a/include/battery_monitor.h b/include/battery_monitor.h
index 4687cef..0431e4e 100644 (file)
--- a/include/battery_monitor.h
+++ b/include/battery_monitor.h
@@ -137,6 +137,8 @@ int battery_monitor_get_usage_for_resource_id(battery_monitor_h handle, battery_
  * @privlevel  public
  * @privilege  %http://tizen.org/privilege/battery.monitor
  *
+ * @remarks  The @a handle should be released using battery_monitor_destroy().
+ *
  * @param[in] app_id  App-id for which battery usage is required
  * @param[in] duration  Time duration for which battery usage is requested
  * @param[out] handle  Battery usage consumption for the app-id
@@ -151,6 +153,8 @@ int battery_monitor_get_usage_for_resource_id(battery_monitor_h handle, battery_
  * @retval #BATTERY_MONITOR_ERROR_DB_FAILED             DB operation failed
  * @retval #BATTERY_MONITOR_ERROR_RECORD_NOT_FOUND      Record Not found
  * @retval #BATTERY_MONITOR_ERROR_INTERNAL              Internal Error
+ *
+ * @see battery_monitor_get_usage_for_resource_id()
  */
 int battery_monitor_get_usage_by_app_id_for_all_resource_id(char *app_id, battery_monitor_duration_type_e duration, battery_monitor_h *handle);