Add details for context history api description

Change-Id: I7b1de12cc88df5375d37b9c8eb3297d070fc7c83
Signed-off-by: Somin Kim <somin926.kim@samsung.com>

diff --git a/include/context_history.h b/include/context_history.h
index 7183fb707505297d0d1b0ede0c8f7e34e3955c44..70a91fcba05f9b8e73e2808175a97bc31744b0b1 100644 (file)
--- a/include/context_history.h
+++ b/include/context_history.h
@@ -31,60 +31,70 @@ extern "C" {
 
 /**
  * @brief      The attribute key denoting "application id"
+ * @details    This can be used as a key of context_history_record_get_string().
  * @since_tizen 2.4
  */
 #define CONTEXT_HISTORY_APP_ID "AppId"
 
 /**
  * @brief      The attribute key denoting "total count"
+ * @details    This can be used as a key of context_history_record_get_int().
  * @since_tizen 2.4
  */
 #define CONTEXT_HISTORY_TOTAL_COUNT "TotalCount"
 
 /**
  * @brief      The attribute key denoting "total amount"
+ * @details    This can be used as a key of context_history_record_get_double().
  * @since_tizen 3.0
  */
 #define CONTEXT_HISTORY_TOTAL_AMOUNT "TotalAmount"
 
 /**
  * @brief      The attribute key denoting "total duration"
+ * @details    This can be used as a key of context_history_record_get_int().
  * @since_tizen 2.4
  */
 #define CONTEXT_HISTORY_TOTAL_DURATION "TotalDuration"
 
 /**
  * @brief      The attribute key denoting "last time"
+ * @details    This can be used as a key of context_history_record_get_int().
  * @since_tizen 2.4
  */
 #define CONTEXT_HISTORY_LAST_TIME "LastTime"
 
 /**
  * @brief      The attribute key denoting "hour of day"
+ * @details    This can be used as a key of context_history_record_get_int().
  * @since_tizen 2.4
  */
 #define CONTEXT_HISTORY_HOUR_OF_DAY "HourOfDay"
 
 /**
  * @brief      The attribute key denoting "audio jack status"
+ * @details    This can be used as a key of context_history_record_get_int().
  * @since_tizen 2.4
  */
 #define CONTEXT_HISTORY_AUDIO_JACK "AudioJack"
 
 /**
  * @brief      The attribute key denoting "system volume"
+ * @details    This can be used as a key of context_history_record_get_int().
  * @since_tizen 2.4
  */
 #define CONTEXT_HISTORY_SYSTEM_VOLUME "SystemVolume"
 
 /**
  * @brief      The attribute key denoting "media volume"
+ * @details    This can be used as a key of context_history_record_get_int().
  * @since_tizen 2.4
  */
 #define CONTEXT_HISTORY_MEDIA_VOLUME "MediaVolume"
 
 /**
  * @brief      The attribute key denoting "address"
+ * @details    This can be used as a key of context_history_record_get_string().
  * @since_tizen 2.4
  */
 #define CONTEXT_HISTORY_ADDRESS "Address"
@@ -294,6 +304,8 @@ int context_history_filter_set_string(context_history_filter_h filter, context_h
 /**
  * @brief              Reads context statistics or patterns.
  * @details            Retrieves a given type of context statistics or patterns list.
+ *                             See the programming guide to find available filter type #context_history_filter_e@n
+ *                             for each context data type #context_history_data_e.
  * @since_tizen 2.4
  *
  * @remarks            The @c list must be released using context_history_list_destroy(). \n
@@ -404,10 +416,12 @@ int context_history_list_destroy(context_history_list_h list);
 
 /**
  * @brief              Gets an integer value from a record.
+ * @details            See the programming guide to find available attribute keys@n
+ *                             for each context data #context_history_data_e.
  * @since_tizen 2.4
  *
  * @param[in]  record          The record handle
- * @param[in]  key                     The key of attribute to get
+ * @param[in]  key                     The key of the attribute to get
  * @param[out] value           The result value
  *
  * @return             0 on success, otherwise a negative error value
@@ -418,15 +432,17 @@ int context_history_list_destroy(context_history_list_h list);
  * @see                context_history_record_get_double()
  * @see                context_history_record_get_string()
  */
-int context_history_record_get_int(context_history_record_h record,  const char* key, int* value);
+int context_history_record_get_int(context_history_record_h record, const char* key, int* value);
 
 /**
  * @brief              Gets a string from a record.
+ * @details            See the programming guide to find available attribute keys@n
+ *                             for each context data #context_history_data_e.
  * @since_tizen 2.4
  * @remarks            @c value must be released using free().
  *
  * @param[in]  record          The record handle
- * @param[in]  key                     The key of attribute to get
+ * @param[in]  key                     The key of the attribute to get
  * @param[out] value           The result value
  *
  * @return             0 on success, otherwise a negative error value
@@ -441,10 +457,12 @@ int context_history_record_get_string(context_history_record_h record, const cha
 
 /**
  * @brief              Gets a double-precision value from a record.
+ * @details            See the programming guide to find available attribute keys@n
+ *                             for each context data #context_history_data_e.
  * @since_tizen 3.0
  *
  * @param[in]  record          The record handle
- * @param[in]  key                     The key of attribute to get
+ * @param[in]  key                     The key of the attribute to get
  * @param[out] value           The result value
  *
  * @return             0 on success, otherwise a negative error value
@@ -455,7 +473,7 @@ int context_history_record_get_string(context_history_record_h record, const cha
  * @see                context_history_record_get_int()
  * @see                context_history_record_get_string()
  */
-int context_history_record_get_double(context_history_record_h record,  const char* key, double* value);
+int context_history_record_get_double(context_history_record_h record, const char* key, double* value);
 
 /**
  * @brief              Destroys a record handle and releases all its resources.