*/
/**
- * @brief The attribute key denoting "application id"
+ * @brief Definition for 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"
+ * @brief Definition for 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"
+ * @brief Definition for 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"
+ * @brief Definition for 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"
+ * @brief Definition for 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"
+ * @brief Definition for 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"
+ * @brief Definition for 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"
+ * @brief Definition for 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"
+ * @brief Definition for 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"
+ * @brief Definition for the attribute key denoting "address".
* @details This can be used as a key of context_history_record_get_string().
* @since_tizen 2.4
*/
} context_history_filter_communication_type_e;
/**
- * @brief Context history handle for retrieving statistics and patterns.
+ * @brief Retrieving statistics and patterns using context history handle.
* @since_tizen 2.4
*/
typedef struct _context_history_handle_s* context_history_h;
/**
- * @brief History filter handle to be used to compute statistics and patterns.
+ * @brief Computing statistics and patterns using history filter handle.
* @since_tizen 2.4
*/
typedef struct _context_history_filter_handle_s* context_history_filter_h;
/**
- * @brief History list handle. It contains one or multiple records.
+ * @brief One or multiple records contained in history list handle.
* @since_tizen 2.4
*/
typedef struct _context_history_list_handle_s* context_history_list_h;
/**
- * @brief History record handle. It contains one or multiple attributes.
+ * @brief One or multiple attributes contained in history list handle.
* @since_tizen 2.4
*/
typedef struct _context_history_record_handle_s* context_history_record_h;
*
* @param[out] handle Handle to be initialized
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_HISTORY_ERROR_OUT_OF_MEMORY Out of memory
*
* @param[in] handle Handle to be released
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
*
*
* @param[out] filter Filter handle to be initialized
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_HISTORY_ERROR_OUT_OF_MEMORY Memory allocation failed
*
* @param[in] filter Filter handle to be released
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
*
* @param[in] filter_type The filter type to set
* @param[in] value The value to be set
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
*
* @param[in] filter_type The filter type to set
* @param[in] value The value to be set
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
*
* @param[in] filter Filter to be used to compute statistics or patterns. This can not be @c NULL
* @param[out] list History data retrieved. This should be freed after use
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_HISTORY_ERROR_OPERATION_FAILED Operation failed
* @param[in] list The history data list handle
* @param[out] count The count of the data list
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_HISTORY_ERROR_OPERATION_FAILED Operation failed
* @param[in] list The context history list handle
* @param[out] record History data record retrieved
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_HISTORY_ERROR_OPERATION_FAILED Operation failed
*
* @param[in] list The context history list handle
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
*
*
* @param[in] list The context history list handle
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_HISTORY_ERROR_NO_DATA Requested data does not exist
*
* @param[in] list The context history data handle
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
*
* @since_tizen 2.4
*
* @param[in] record The record handle
- * @param[in] key The key of the attribute to get
+ * @param[in] key The key of attribute to get
* @param[out] value The result value
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
*
* @remarks @c value must be released using free().
*
* @param[in] record The record handle
- * @param[in] key The key of the attribute to get
+ * @param[in] key The key of attribute to get
* @param[out] value The result value
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
*
* @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
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
*
*
* @param[in] record The record handle
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_HISTORY_ERROR_NONE Successful
* @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter
*
#endif /* __cplusplus */
/**
- * @brief The operator "is equal to".
+ * @brief Definition for the operator "is equal to".
* @details This can be used as operators of context_trigger_rule_entry_add_comparison_int()
* and context_trigger_rule_entry_add_comparison_string().
* @since_tizen 2.4
#define CONTEXT_TRIGGER_EQUAL_TO "=="
/**
- * @brief The operator "is not equal to".
+ * @brief Definition for the operator "is not equal to".
* @details This can be used as operators of context_trigger_rule_entry_add_comparison_int()
* and context_trigger_rule_entry_add_comparison_string().
* @since_tizen 2.4
#define CONTEXT_TRIGGER_NOT_EQUAL_TO "!="
/**
- * @brief The operator "is greater than".
+ * @brief Definition for the operator "is greater than".
* @details This can be used as operators of context_trigger_rule_entry_add_comparison_int().
* @since_tizen 2.4
*/
#define CONTEXT_TRIGGER_GREATER_THAN ">"
/**
- * @brief The operator "is greater than or equal to".
+ * @brief Definition for the operator "is greater than or equal to".
* @details This can be used as operators of context_trigger_rule_entry_add_comparison_int().
* @since_tizen 2.4
*/
#define CONTEXT_TRIGGER_GREATER_THAN_OR_EQUAL_TO ">="
/**
- * @brief The operator "is less than".
+ * @brief Definition for the operator "is less than".
* @details This can be used as operators of context_trigger_rule_entry_add_comparison_int().
* @since_tizen 2.4
*/
#define CONTEXT_TRIGGER_LESS_THAN "<"
/**
- * @brief The operator "is less than or equal to".
+ * @brief Definition for the operator "is less than or equal to".
* @details This can be used as operators of context_trigger_rule_entry_add_comparison_int().
* @since_tizen 2.4
*/
#define CONTEXT_TRIGGER_LESS_THAN_OR_EQUAL_TO "<="
/**
- * @brief Logical true.
+ * @brief Definition for the logical true.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_int().
* @since_tizen 2.4
*/
#define CONTEXT_TRIGGER_TRUE 1
/**
- * @brief Logical false.
+ * @brief Definition for the logical false.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_int().
* @since_tizen 2.4
*/
#define CONTEXT_TRIGGER_FALSE 0
/**
- * @brief The attribute key denoting "time of day".
+ * @brief Definition for the attribute key denoting "time of day".
* @details This can be used as a key of context_trigger_rule_entry_add_option_string(),
* or left operands of context_trigger_rule_entry_add_comparison_int().@n
* When being used as option, it is time interval of the day. For example, "13-15" denotes "from 1 PM to 3 PM".
#define CONTEXT_TRIGGER_TIME_OF_DAY "TimeOfDay"
/**
- * @brief The attribute key denoting "day of week".
+ * @brief Definition for the attribute key denoting "day of week".
* @details This can be used as a key of context_trigger_rule_entry_add_option_string(),
* or left operands of context_trigger_rule_entry_add_comparison_string().@n
* As the right operands of this attribute, one of the following values are allowed:
#define CONTEXT_TRIGGER_DAY_OF_WEEK "DayOfWeek"
/**
- * @brief The attribute key denoting "day of month".
+ * @brief Definition for the attribute key denoting "day of month".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_int().@n
* The valid range of the corresponding right operands is from 1 to 31.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_DAY_OF_MONTH "DayOfMonth"
/**
- * @brief The attribute key denoting boolean states of "is connected".
+ * @brief Definition for the attribute key denoting boolean states of "is connected".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_int().@n
* As the right operands of this attribute, one of the following values are allowed:
* #CONTEXT_TRIGGER_TRUE and #CONTEXT_TRIGGER_FALSE.
#define CONTEXT_TRIGGER_IS_CONNECTED "IsConnected"
/**
- * @brief The attribute key denoting boolean states of "is charging".
+ * @brief Definition for the attribute key denoting boolean states of "is charging".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_int().@n
* As the right operands of this attribute, one of the following values are allowed:
* #CONTEXT_TRIGGER_TRUE and #CONTEXT_TRIGGER_FALSE.
#define CONTEXT_TRIGGER_IS_CHARGING "IsCharging"
/**
- * @brief The attribute key denoting boolean states of "is enabled".
+ * @brief Definition for the attribute key denoting boolean states of "is enabled".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_int().@n
* As the right operands of this attribute, one of the following values are allowed:
* #CONTEXT_TRIGGER_TRUE and #CONTEXT_TRIGGER_FALSE.
#define CONTEXT_TRIGGER_IS_ENABLED "IsEnabled"
/**
- * @brief The attribute key denoting "level".
+ * @brief Definition for the attribute key denoting "level".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find available right operands values.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_LEVEL "Level"
/**
- * @brief The attribute key denoting "state".
+ * @brief Definition for the attribute key denoting "state".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find available right operands.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_STATE "State"
/**
- * @brief The attribute key denoting "BSSID".
+ * @brief Definition for the attribute key denoting "BSSID".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find available right operands.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_BSSID "BSSID"
/**
- * @brief The attribute key denoting "type".
+ * @brief Definition for the attribute key denoting "type".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find available right operands.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_TYPE "Type"
/**
- * @brief The attribute key denoting "event".
+ * @brief Definition for the attribute key denoting "event".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find available right operands.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_EVENT "Event"
/**
- * @brief The attribute key denoting "accuracy".
+ * @brief Definition for the attribute key denoting "accuracy".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find available right operands.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_ACCURACY "Accuracy"
/**
- * @brief The attribute key denoting "medium".
+ * @brief Definition for the attribute key denoting "medium".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find available right operands.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_MEDIUM "Medium"
/**
- * @brief The attribute key denoting "place id".
+ * @brief Definition for the attribute key denoting "place id".
* @details This can be used as a key of context_trigger_rule_entry_add_option_int().@n
* See the programming guide to find the corresponding trigger events.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_PLACE_ID "PlaceId"
/**
- * @brief The attribute key denoting "application id".
+ * @brief Definition for the attribute key denoting "application id".
* @details This can be used as a key of context_trigger_rule_entry_add_option_string().@n
* See the programming guide to find the corresponding trigger events.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_APP_ID "AppId"
/**
- * @brief The attribute key denoting "address".
+ * @brief Definition for the attribute key denoting "address".
* @details This can be used as a key of context_trigger_rule_entry_add_option_string(),
* or context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide and CAPI_CONTEXT_TRIGGER_MODULE_OPTION_FORMAT to find the corresponding items.
#define CONTEXT_TRIGGER_ADDRESS "Address"
/**
- * @brief The attribute key denoting "rank".
+ * @brief Definition for the attribute key denoting "rank".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_int().@n
* See the programming guide to find available right operands.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_RANK "Rank"
/**
- * @brief The attribute key denoting "total count".
+ * @brief Definition for the attribute key denoting "total count".
* @details This can be used as left operands of context_trigger_rule_entry_add_comparison_int().@n
* See the programming guide to find available right operands.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_TOTAL_COUNT "TotalCount"
/**
- * @brief The attribute value denoting Monday.
+ * @brief Definition for the attribute value denoting Monday.
* @details This can be used as a value of context_trigger_rule_entry_add_option_string()
* or right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding option keys or left operand attribute keys.
#define CONTEXT_TRIGGER_MON "Mon"
/**
- * @brief The attribute value denoting Tuesday.
+ * @brief Definition for the attribute value denoting Tuesday.
* @details This can be used as a value of context_trigger_rule_entry_add_option_string()
* or right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding option keys or left operand attribute keys.
#define CONTEXT_TRIGGER_TUE "Tue"
/**
- * @brief The attribute value denoting Wednesday.
+ * @brief Definition for the attribute value denoting Wednesday.
* @details This can be used as a value of context_trigger_rule_entry_add_option_string()
* or right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding option keys or left operand attribute keys.
#define CONTEXT_TRIGGER_WED "Wed"
/**
- * @brief The attribute value denoting Thursday.
+ * @brief Definition for the attribute value denoting Thursday.
* @details This can be used as a value of context_trigger_rule_entry_add_option_string()
* or right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding option keys or left operand attribute keys.
#define CONTEXT_TRIGGER_THU "Thu"
/**
- * @brief The attribute value denoting Friday.
+ * @brief Definition for the attribute value denoting Friday.
* @details This can be used as a value of context_trigger_rule_entry_add_option_string()
* or right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding option keys or left operand attribute keys.
#define CONTEXT_TRIGGER_FRI "Fri"
/**
- * @brief The attribute value denoting Saturday.
+ * @brief Definition for the attribute value denoting Saturday.
* @details This can be used as a value of context_trigger_rule_entry_add_option_string()
* or right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding option keys or left operand attribute keys.
#define CONTEXT_TRIGGER_SAT "Sat"
/**
- * @brief The attribute value denoting Sunday.
+ * @brief Definition for the attribute value denoting Sunday.
* @details This can be used as a value of context_trigger_rule_entry_add_option_string()
* or right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding option keys or left operand attribute keys.
#define CONTEXT_TRIGGER_SUN "Sun"
/**
- * @brief The attribute value denoting Weekdays.
+ * @brief Definition for the attribute value denoting Weekdays.
* @details This can be used as a value of context_trigger_rule_entry_add_option_string()
* or right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding option keys or left operand attribute keys.
#define CONTEXT_TRIGGER_WEEKDAY "Weekday"
/**
- * @brief The attribute value denoting Weekends.
+ * @brief Definition for the attribute value denoting Weekends.
* @details This can be used as a value of context_trigger_rule_entry_add_option_string()
* or right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding option keys or left operand attribute keys.
#define CONTEXT_TRIGGER_WEEKEND "Weekend"
/**
- * @brief The attribute value denoting the "empty" state.
+ * @brief Definition for the attribute value denoting the "empty" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_EMPTY "Empty"
/**
- * @brief The attribute value denoting the "critical" state.
+ * @brief Definition for the attribute value denoting the "critical" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_CRITICAL "Critical"
/**
- * @brief The attribute value denoting the "low" state.
+ * @brief Definition for the attribute value denoting the "low" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_LOW "Low"
/**
- * @brief The attribute value denoting the "normal" state.
+ * @brief Definition for the attribute value denoting the "normal" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_NORMAL "Normal"
/**
- * @brief The attribute value denoting the "high" state.
+ * @brief Definition for the attribute value denoting the "high" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_HIGH "High"
/**
- * @brief The attribute value denoting the "full" state.
+ * @brief Definition for the attribute value denoting the "full" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_FULL "Full"
/**
- * @brief The attribute value denoting the "disabled" state.
+ * @brief Definition for the attribute value denoting the "disabled" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_DISABLED "Disabled"
/**
- * @brief The attribute value denoting the "searching" state.
+ * @brief Definition for the attribute value denoting the "searching" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_SEARCHING "Searching"
/**
- * @brief The attribute value denoting the "connecting" state.
+ * @brief Definition for the attribute value denoting the "connecting" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_CONNECTING "Connecting"
/**
- * @brief The attribute value denoting the "connected" state.
+ * @brief Definition for the attribute value denoting the "connected" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_CONNECTED "Connected"
/**
- * @brief The attribute value denoting the "unconnected" state.
+ * @brief Definition for the attribute value denoting the "unconnected" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_UNCONNECTED "Unconnected"
/**
- * @brief The attribute value denoting the "idle" state.
+ * @brief Definition for the attribute value denoting the "idle" state.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_IDLE "Idle"
/**
- * @brief The attribute value denoting the "voice" type.
+ * @brief Definition for the attribute value denoting the "voice" type.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_VOICE "Voice"
/**
- * @brief The attribute value denoting the "video" type.
+ * @brief Definition for the attribute value denoting the "video" type.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_VIDEO "Video"
/**
- * @brief The attribute value denoting the "headset" type.
+ * @brief Definition for the attribute value denoting the "headset" type.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_HEADSET "Headset"
/**
- * @brief The attribute value denoting the "bluetooth" type.
+ * @brief Definition for the attribute value denoting the "bluetooth" type.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_BLUETOOTH "Bluetooth"
/**
- * @brief The attribute value denoting the "received" event.
+ * @brief Definition for the attribute value denoting the "received" event.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_RECEIVED "Received"
/**
- * @brief The attribute value denoting the "sent" event.
+ * @brief Definition for the attribute value denoting the "sent" event.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_SENT "Sent"
/**
- * @brief The attribute value denoting the "SMS" type.
+ * @brief Definition for the attribute value denoting the "SMS" type.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_SMS "SMS"
/**
- * @brief The attribute value denoting the "MMS" type.
+ * @brief Definition for the attribute value denoting the "MMS" type.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_MMS "MMS"
/**
- * @brief The attribute value denoting the "my profile" view.
+ * @brief Definition for the attribute value denoting the "my profile" view.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 3.0
#define CONTEXT_TRIGGER_MY_PROFILE "MyProfile"
/**
- * @brief The attribute value denoting the "person" view.
+ * @brief Definition for the attribute value denoting the "person" view.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 3.0
#define CONTEXT_TRIGGER_PERSON "Person"
/**
- * @brief The attribute value denoting the "Changed" event.
+ * @brief Definition for the attribute value denoting the "Changed" event.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 3.0
#define CONTEXT_TRIGGER_CHANGED "Changed"
/**
- * @brief The attribute value denoting the "detected" event.
+ * @brief Definition for the attribute value denoting the "detected" event.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_DETECTED "Detected"
/**
- * @brief The attribute value denoting the "in" event.
+ * @brief Definition for the attribute value denoting the "in" event.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_IN "In"
/**
- * @brief The attribute value denoting the "out" event.
+ * @brief Definition for the attribute value denoting the "out" event.
* @details This can be used as right operands of context_trigger_rule_entry_add_comparison_string().@n
* See the programming guide to find the corresponding left operand attribute keys.
* @since_tizen 2.4
#define CONTEXT_TRIGGER_OUT "Out"
/**
- * @brief Enumeration of error codes for context trigger API.
+ * @brief Enumeration for context trigger API of error codes.
* @since_tizen 2.4
*/
typedef enum {
} context_trigger_logical_type_e;
/**
- * @brief Handle for editing a trigger rule.
+ * @brief Trigger rule editing handle.
* @since_tizen 2.4
*/
typedef struct _context_trigger_rule_s* context_trigger_rule_h;
/**
- * @brief Handle for editing an event or a condition, which is added to a rule.
+ * @brief Editing an event or a condition, which is added to a rule using handle.
* @since_tizen 2.4
*/
typedef struct _context_trigger_rule_entry_s* context_trigger_rule_entry_h;
* @param[in] rule The rule to register
* @param[out] rule_id The ID assigned to the @a rule
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_PERMISSION_DENIED Permission denied
*
* @param[in] rule_id The ID of the rule to be removed
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
*
* @param[in] rule_id The ID of the rule to be enabled
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_NOT_SUPPORTED Unsupported event/condition contained
*
* @param[in] rule_id The ID of the rule to be disabled
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[out] disabled_rule_ids The IDs of the inactive rules
* @param[out] disabled_rule_count The number of the inactive rules
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] rule_id The ID of the rule to be retrieved
* @param[out] rule The rule retrieved
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] logical_type The logical operator
* @param[out] rule The rule handle to be initialized
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Memory allocation failed
*
* @param[in] rule The rule handle to be released
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
*
* @param[in] rule The rule
* @param[in] entry The event or condition entry to be added to the rule
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] rule The rule
* @param[in] app_control The App Control, which will be used to launch an application
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_PERMISSION_DENIED Permission denied
* @param[in] icon_path The icon file path
* @param[in] app_control The app control
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_PERMISSION_DENIED Permission denied
* @param[in] rule The rule
* @param[in] description The description to be set
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] rule The rule
* @param[out] description The description of the rule
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] logical_type The logical operator
* @param[out] entry The event entry to be initialized
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Memory allocation failed
* @param[in] event_item The contextual event item
* @param[out] supported If supported, @c true; Otherwise, @c false
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OPERATION_FAILED Operation failed
* @param[in] logical_type The logical operator
* @param[out] entry The condition entry to be initialized
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Memory allocation failed
* @param[in] condition_item The contextual condition item
* @param[out] supported If supported, @c true; Otherwise, @c false
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OPERATION_FAILED Operation failed
*
* @param[in] entry The event or condition entry
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
*
* @param[in] option_key The option key
* @param[in] value The option value
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] option_key The option key
* @param[in] value The option value
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] option_key The option key
* @param[in] event_data_key The event data key of which the corresponding data value will be used as the option parameter
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] logical_type The logical operator
* @param[in] key The attribute key
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] comp_operator The comparison operator
* @param[in] value The right operand value
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] comp_operator The comparison operator
* @param[in] value The right operand value
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] comp_operator The comparison operator
* @param[in] event_data_key The event data key of which the corresponding data value will be used as the right operand
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] name The name of a custom contextual data item
* @param[in] attr_template The attribute template which explains contextual data schema in JSON format
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Out of memory
*
* @param[in] name The name of a custom contextual data item
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OPERATION_FAILED Operation failed
* @param[in] name The name of custom contextual data item
* @param[in] fact The contextual data to be provided in JSON format
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_NOT_SUPPORTED Unsupported event/condition contained
* @param[in] logical_type The logical operator
* @param[out] entry The event entry to be initialized
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Memory allocation failed
* @param[in] logical_type The logical operator
* @param[out] entry The condition entry to be initialized
*
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
* @retval #CONTEXT_TRIGGER_ERROR_NONE Successful
* @retval #CONTEXT_TRIGGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTEXT_TRIGGER_ERROR_OUT_OF_MEMORY Memory allocation failed