resource-monitor: doc: Add CAPI_SYSTEM_MONITOR_MODULE and update description

Compose the following domain tree of resource monitor
by adding CAPI_SYSTEM_MONITOR_MODULE and update the description
of resource monitor API>

[Domain tree of system monitor]
 CAPI_SYSTEM_FRAMEWORK : System
 - CAPI_SYSTEM_MONITOR_MODULE : Monitor
 -- CAPI_SYSTEM_RESOURCE_MONITOR_MODULE : Resource Monitor

Change-Id: I75907f21bdda6016554a1a59574e013973064088
Signed-off-by: Chanwoo Choi <cw00.choi@samsung.com>

diff --git a/doc/resource-monitor-doc.h b/doc/resource-monitor-doc.h
index ef488be6ffb7f9951347120364893d4383ff450e..740293a49af4548472049a601ddb3f6e71ef633e 100644 (file)
--- a/doc/resource-monitor-doc.h
+++ b/doc/resource-monitor-doc.h
@@ -20,25 +20,48 @@
 /**
  * @file resource-monitor-doc.h
  * @brief This file contains high level documentation for the Resource Monitor API.
- *
  */
 
 /**
- * @defgroup CAPI_SYSTEM_RESOURCE_MONITOR_MODULE Resource Monitor
  * @ingroup CAPI_SYSTEM_FRAMEWORK
+ * @defgroup CAPI_SYSTEM_MONITOR_MODULE Monitor
+ * @brief The Monitor API provides functions to monitor various device status.
+ *
+ * @section CAPI_SYSTEM_MONITOR_MODULE_HEADER Required Header
+ *    \#include <system/resource_monitor.h>
+ *
+ * @section CAPI_SYSTEM_MONITOR_MODULE_OVERVIEW Overview
+ * - Resource Monitor : The @ref CAPI_SYSTEM_RESOURCE_MONITOR_MODULE API provides functions for monitoring the devices such as CPU, GPU, Bus, Disk, System and so on.
  */
 
 /**
- * @ingroup CAPI_SYSTEM_FRAMEWORK
- * @addtogroup CAPI_SYSTEM_RESOURCE_MONITOR_MODULE
- * @brief The @ref CAPI_SYSTEM_RESOURCE_MONITOR_MODULE API provides functions for monitoring the devices such as Process, CPU, GPU, Memory Bus, Network, Disk and so on.
+ * @ingroup CAPI_SYSTEM_MONITOR_MODULE
+ * @defgroup CAPI_SYSTEM_RESOURCE_MONITOR_MODULE Resource Monitor
+ * @brief The @ref CAPI_SYSTEM_RESOURCE_MONITOR_MODULE API provides functions for monitoring the devices such as CPU, GPU, Bus, Disk, System and so on.
  * @section CAPI_SYSTEM_RESOURCE_MONITOR_MODULE_HEADER Required Header
  *    \#include <system/resource_monitor.h>
  *
- * @section CAPI_SYSTEM_RESOURCE_MONITOR_MODULE_OVERVIEW Overview
- * The Resource Monitor API provides a set of functions to monitor the resources such as Process, CPU, GPU, Memory Bus, Network, Disk and so on.
+ @section CAPI_SYSTEM_RESOURCE_MONITOR_MODULE_OVERVIEW Overview
+ * The Resource Monitor API provides a set of functions to monitor the resources.
+ * It is required to monitor the various resources at the same time.
+ *
+ * Each resource has the different monitoring data aka the resource attribute.
+ * The user of Resource Monitor API is able to select both the monitored resources
+ * and the monitored resource attributes they want before monitoring.
+ * Finally, the user can get the monitored value set they want at the same time.
+ *
+ * The user is able to know the system status by analyzing the monitored data set.
+ * Also, the analysis of system status will be used to optimize the platform and application.
  *
- * TODO
+ * The Resource Monitor API allows to monitor the following resource types:
+ * - CPU
+ * - Bus
+ * - GPU
+ * - Memory
+ * - Battery
+ * - Display
+ * - System
+ * - Disk
  */
 
 #endif /* __TIZEN_SYSTEM_RESOURCE_MONITOR_DOC_H__ */