API descriptions of the URIs

Change-Id: Ia6ee02c61b1873796b1aed71e29dd1b09b669e5b
Signed-off-by: Mu-Woong Lee <muwoong.lee@samsung.com>

diff --git a/include/job_scheduler_types_internal.h b/include/job_scheduler_types_internal.h
index ea513c9419a44f54a4bd406e05858754d7d08301..f5edee33ec6d6fe55c7a66478bf16a1f8bff0328 100644 (file)
--- a/include/job_scheduler_types_internal.h
+++ b/include/job_scheduler_types_internal.h
@@ -17,25 +17,127 @@
 #ifndef __CAPI_CONTEXT_JOB_SCHEDULER_TYPES_INTERNAL_H__
 #define __CAPI_CONTEXT_JOB_SCHEDULER_TYPES_INTERNAL_H__
 
+/**
+ * @ingroup            CAPI_CONTEXT_JOB_SCHEDULER_INTERNAL_MODULE
+ * @defgroup   CAPI_CONTEXT_JOB_SCHEDULER_INTERNAL_ATTRIBUTE Attribute Names and Values
+ * @addtogroup CAPI_CONTEXT_JOB_SCHEDULER_INTERNAL_ATTRIBUTE
+ * @{
+ */
+
 /* URIs */
+
+/**
+ * @brief      Prefix of URIs
+ */
 #define CTX_SCHED_URI_PREFIX           "http://tizen.org/context/"
 
+/**
+ * @brief      URI of the battery state
+ * @details    It can be used as a trigger or a requirement. Available attributes and their values are:
+ *                     - "Level" = {"Empty", "Critical", "Low", "Normal", "High", "Full"}
+ *                     - "IsCharging" ∈ {0, 1}
+ */
 #define CTX_SCHED_URI_BATTERY          CTX_SCHED_URI_PREFIX "state/battery"
+
+/**
+ * @brief      URI of the charger connection
+ * @details    It can be used as a trigger or a requirement. Available attribute and its values are:
+ *                     - "IsConnected" ∈ {0, 1}
+ */
 #define CTX_SCHED_URI_CHARGER          CTX_SCHED_URI_PREFIX "state/charger"
+
+/**
+ * @brief      URI of the display state
+ * @details    It can be used as a trigger or a requirement. Available attribute and its values are:
+ *                     - "State" ∈ {"On", "Dim", "Off"}
+ */
 #define CTX_SCHED_URI_DISPLAY          CTX_SCHED_URI_PREFIX "state/display"
+
+/**
+ * @brief      URI of the headphone jack connection
+ * @details    It can be used as a trigger or a requirement. Available attributes and their values are:
+ *                     - "IsConnected" ∈ {0, 1}
+ *                     - "Type" ∈ {"Normal", "Headset"}
+ */
 #define CTX_SCHED_URI_EARJACK          CTX_SCHED_URI_PREFIX "state/earjack"
+
+/**
+ * @brief      URI of the GPS state
+ * @details    It can be used as a trigger or a requirement. Available attribute and its values are:
+ *                     - "State" ∈ {"Disabled", "Searching", "Connected"}
+ */
 #define CTX_SCHED_URI_GPS                      CTX_SCHED_URI_PREFIX "state/gps"
+
+/**
+ * @brief      URI of the device's power-saving mode
+ * @details    It can be used as a trigger or a requirement. Available attribute and its values are:
+ *                     - TBD
+ */
 #define CTX_SCHED_URI_POWERSAVE                CTX_SCHED_URI_PREFIX "state/powersave"
+
+/**
+ * @brief      URI of the USB connection
+ * @details    It can be used as a trigger or a requirement. Available attribute and its values are:
+ *                     - "IsConnected" ∈ {0, 1}
+ */
 #define CTX_SCHED_URI_USB                      CTX_SCHED_URI_PREFIX "state/usb"
+
+/**
+ * @brief      URI of the WiFi state
+ * @details    It can be used as a trigger or a requirement. Available attributes and their values are:
+ *                     - "State" ∈ {"Disabled", "Unconnected", "Connected"}
+ *                     - "BSSID": a BSSID string, which can be acquired using the Wi-Fi Manager API
+ */
 #define CTX_SCHED_URI_WIFI                     CTX_SCHED_URI_PREFIX "state/wifi"
+
+/**
+ * @brief      URI of the current time
+ * @details    It can be used as a requirement. Available attributes and their values are:
+ *                     - "DayOfMonth" ∈ [1, 31]
+ *                     - "DayOfWeek" ∈ {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}
+ *                     - "TimeOfDay" ∈ [1, 1440), in minute
+ */
 #define CTX_SCHED_URI_TIME                     CTX_SCHED_URI_PREFIX "state/time"
 
+/**
+ * @brief      URI of the user's stationary activity
+ * @details    It can be used as a trigger. Available attributes and their values are:
+ *                     - "Event" ∈ {"Detected"}
+ *                     - "Accuracy" ∈ {"High", "Normal", "Low"}
+ */
 #define CTX_SCHED_URI_STATIONARY       CTX_SCHED_URI_PREFIX "event/stationary"
+
+/**
+ * @brief      URI of the user's walking activity
+ * @see                #CTX_SCHED_URI_STATIONARY
+ */
 #define CTX_SCHED_URI_WALKING          CTX_SCHED_URI_PREFIX "event/walking"
+
+/**
+ * @brief      URI of the user's running activity
+ * @see                #CTX_SCHED_URI_STATIONARY
+ */
 #define CTX_SCHED_URI_RUNNING          CTX_SCHED_URI_PREFIX "event/running"
+
+/**
+ * @brief      URI of the user's in-vehicle activity
+ * @see                #CTX_SCHED_URI_STATIONARY
+ */
 #define CTX_SCHED_URI_IN_VEHICLE       CTX_SCHED_URI_PREFIX "event/in_vehicle"
+
+/**
+ * @brief      URI of the geofencing event
+ * @details    It can be used as a trigger. Available attributes and their values are:
+ *                     - "Event" ∈ {"In", "Out"}
+ *                     - "PlaceId": a place ID registered by the Geofence Manager API
+ */
 #define CTX_SCHED_URI_GEOFENCE         CTX_SCHED_URI_PREFIX "event/geofence"
 
+/**
+ * @brief      URI of the Contacts DB change event
+ * @details    It can be used as a trigger. Available attribute and its values are:
+ *                     - "Event" ∈ {"Changed"}
+ */
 #define CTX_SCHED_URI_CONTACTS_DB      CTX_SCHED_URI_PREFIX "event/contacts_db"
 
 /* Attribute names */
@@ -86,4 +188,8 @@
 #define CTX_SCHED_ATTR_VALUE_FRI                       "Fri"
 #define CTX_SCHED_ATTR_VALUE_SAT                       "Sat"
 
+/**
+ * @}
+ */
+
 #endif