summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSukHyung, Kang <shine.kang@samsung.com>2019-11-13 13:39:16 +0900
committerSukHyung, Kang <shine.kang@samsung.com>2019-11-13 15:24:43 +0900
commitbdbd3ba146e398aab1c7ca1bae535e3721e7323a (patch)
tree8a19e76d4abf70f31c201e1ec475f6f294cbecd8
parent34f73cee3224af8926f5fe8f24e4958f0640ddd3 (diff)
downloadapplication-bdbd3ba146e398aab1c7ca1bae535e3721e7323a.tar.gz
application-bdbd3ba146e398aab1c7ca1bae535e3721e7323a.tar.bz2
application-bdbd3ba146e398aab1c7ca1bae535e3721e7323a.zip
Fix api reference for application
Change-Id: Idfd69cf39eca459f9b569c564be2d54f1e82e13d Signed-off-by: SukHyung, Kang <shine.kang@samsung.com>
-rwxr-xr-xdoc/appfw_event_doc.h158
-rwxr-xr-xdoc/appfw_resource_manager_doc.h8
2 files changed, 83 insertions, 83 deletions
diff --git a/doc/appfw_event_doc.h b/doc/appfw_event_doc.h
index 1adb65f..ed818b2 100755
--- a/doc/appfw_event_doc.h
+++ b/doc/appfw_event_doc.h
@@ -52,11 +52,11 @@
* @subsection CAPI_EVENT_MODULE_LAUNCH_ON_EVENT Launch-On-Event (Service Application only)
* Service application can be launched by event triggering.
* For Launch-On-Event,
- * - The APP_CONTROL_OPERATION_LAUNCH_ON_EVENT must be defined in the manifest file.
+ * - The #APP_CONTROL_OPERATION_LAUNCH_ON_EVENT must be defined in the manifest file.
* - The URI name represents event name and the format is "event://{event name"}".
* For URI example,
* "event://tizen.system.event.battery_charger_status". (System-Event)
- * - The APP_CONTROL_OPERATION_LAUNCH_ON_EVENT can not be requested via app_control_send_launch_request().
+ * - The #APP_CONTROL_OPERATION_LAUNCH_ON_EVENT can not be requested via app_control_send_launch_request().
* How to know the triggered event after launch by event triggering.
* - You can get the event name and data in the first call of app_control_cb, which is called after 'Created' of application states.
*
@@ -96,19 +96,19 @@
* <th>Condition</th>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_BATTERY_CHARGER_STATUS</td>
+ * <td>#SYSTEM_EVENT_BATTERY_CHARGER_STATUS</td>
* <td>When Charger CONNECTED</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_USB_STATUS</td>
+ * <td>#SYSTEM_EVENT_USB_STATUS</td>
* <td>When USB CONNECTED</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_EARJACK_STATUS</td>
+ * <td>#SYSTEM_EVENT_EARJACK_STATUS</td>
* <td>When Earjack CONNECTED</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_INCOMING_MSG</td>
+ * <td>#SYSTEM_EVENT_INCOMING_MSG</td>
* <td>When MSG_TYPE & MSG_ID exist</td>
* </tr>
* </table>
@@ -127,146 +127,146 @@
* <th>Value</th>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_BATTERY_CHARGER_STATUS</td>
- * <td>EVENT_KEY_BATTERY_CHARGER_STATUS</td>
- * <td>EVENT_VAL_BATTERY_CHARGER_DISCONNECTED<br/>EVENT_VAL_BATTERY_CHARGER_CONNECTED<br/>EVENT_VAL_BATTERY_CHARGER_CHARGING<br/>EVENT_VAL_BATTERY_CHARGER_DISCHARGING</td>
+ * <td>#SYSTEM_EVENT_BATTERY_CHARGER_STATUS</td>
+ * <td>#EVENT_KEY_BATTERY_CHARGER_STATUS</td>
+ * <td>#EVENT_VAL_BATTERY_CHARGER_DISCONNECTED<br/>#EVENT_VAL_BATTERY_CHARGER_CONNECTED<br/>#EVENT_VAL_BATTERY_CHARGER_CHARGING<br/>#EVENT_VAL_BATTERY_CHARGER_DISCHARGING</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_BATTERY_LEVEL_STATUS</td>
- * <td>EVENT_KEY_BATTERY_LEVEL_STATUS</td>
- * <td>EVENT_VAL_BATTERY_LEVEL_EMPTY<br/>EVENT_VAL_BATTERY_LEVEL_CRITICAL<br/>EVENT_VAL_BATTERY_LEVEL_LOW<br/>EVENT_VAL_BATTERY_LEVEL_HIGH<br/>EVENT_VAL_BATTERY_LEVEL_FULL</td>
+ * <td>#SYSTEM_EVENT_BATTERY_LEVEL_STATUS</td>
+ * <td>#EVENT_KEY_BATTERY_LEVEL_STATUS</td>
+ * <td>#EVENT_VAL_BATTERY_LEVEL_EMPTY<br/>#EVENT_VAL_BATTERY_LEVEL_CRITICAL<br/>#EVENT_VAL_BATTERY_LEVEL_LOW<br/>#EVENT_VAL_BATTERY_LEVEL_HIGH<br/>#EVENT_VAL_BATTERY_LEVEL_FULL</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_USB_STATUS</td>
- * <td>EVENT_KEY_USB_STATUS</td>
- * <td>EVENT_VAL_USB_DISCONNECTED<br/>EVENT_VAL_USB_CONNECTED<br/>EVENT_VAL_USB_AVAILABLE</td>
+ * <td>#SYSTEM_EVENT_USB_STATUS</td>
+ * <td>#EVENT_KEY_USB_STATUS</td>
+ * <td>#EVENT_VAL_USB_DISCONNECTED<br/>#EVENT_VAL_USB_CONNECTED<br/>#EVENT_VAL_USB_AVAILABLE</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_EARJACK_STATUS</td>
- * <td>EVENT_KEY_EARJACK_STATUS</td>
- * <td>EVENT_VAL_EARJACK_DISCONNECTED<br/>EVENT_VAL_EARJACK_CONNECTED</td>
+ * <td>#SYSTEM_EVENT_EARJACK_STATUS</td>
+ * <td>#EVENT_KEY_EARJACK_STATUS</td>
+ * <td>#EVENT_VAL_EARJACK_DISCONNECTED<br/>#EVENT_VAL_EARJACK_CONNECTED</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_DISPLAY_STATE</td>
- * <td>EVENT_KEY_DISPLAY_STATE</td>
- * <td>EVENT_VAL_DISPLAY_NORMAL<br/>EVENT_VAL_DISPLAY_DIM<br/>EVENT_VAL_DISPLAY_OFF</td>
+ * <td>#SYSTEM_EVENT_DISPLAY_STATE</td>
+ * <td>#EVENT_KEY_DISPLAY_STATE</td>
+ * <td>#EVENT_VAL_DISPLAY_NORMAL<br/>#EVENT_VAL_DISPLAY_DIM<br/>#EVENT_VAL_DISPLAY_OFF</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_BOOT_COMPLETED</td>
+ * <td>#SYSTEM_EVENT_BOOT_COMPLETED</td>
* <td>N/A</td>
* <td>N/A</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_SYSTEM_SHUTDOWN</td>
+ * <td>#SYSTEM_EVENT_SYSTEM_SHUTDOWN</td>
* <td>N/A</td>
* <td>N/A</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_LOW_MEMORY</td>
- * <td>EVENT_KEY_LOW_MEMORY</td>
- * <td>EVENT_VAL_MEMORY_NORMAL<br/>EVENT_VAL_MEMORY_SOFT_WARNING<br/>EVENT_VAL_MEMORY_HARD_WARNING</td>
+ * <td>#SYSTEM_EVENT_LOW_MEMORY</td>
+ * <td>#EVENT_KEY_LOW_MEMORY</td>
+ * <td>#EVENT_VAL_MEMORY_NORMAL<br/>#EVENT_VAL_MEMORY_SOFT_WARNING<br/>#EVENT_VAL_MEMORY_HARD_WARNING</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_WIFI_STATE</td>
- * <td>EVENT_KEY_WIFI_STATE</td>
- * <td>EVENT_VAL_WIFI_OFF<br/>EVENT_VAL_WIFI_ON<br/>EVENT_VAL_WIFI_CONNECTED</td>
+ * <td>#SYSTEM_EVENT_WIFI_STATE</td>
+ * <td>#EVENT_KEY_WIFI_STATE</td>
+ * <td>#EVENT_VAL_WIFI_OFF<br/>#EVENT_VAL_WIFI_ON<br/>#EVENT_VAL_WIFI_CONNECTED</td>
* </tr>
* <tr>
- * <td rowspan="3">SYSTEM_EVENT_BT_STATE</td>
- * <td>EVENT_KEY_BT_STATE</td>
- * <td>EVENT_VAL_BT_OFF<br/>EVENT_VAL_BT_ON</td>
+ * <td rowspan="3">#SYSTEM_EVENT_BT_STATE</td>
+ * <td>#EVENT_KEY_BT_STATE</td>
+ * <td>#EVENT_VAL_BT_OFF<br/>#EVENT_VAL_BT_ON</td>
* </tr>
* <tr>
- * <td>EVENT_KEY_BT_LE_STATE</td>
- * <td>EVENT_VAL_BT_LE_OFF<br/>EVENT_VAL_BT_LE_ON</td>
+ * <td>#EVENT_KEY_BT_LE_STATE</td>
+ * <td>#EVENT_VAL_BT_LE_OFF<br/>#EVENT_VAL_BT_LE_ON</td>
* </tr>
* <tr>
- * <td>EVENT_KEY_BT_TRANSFERING_STATE</td>
- * <td>EVENT_VAL_BT_NON_TRANSFERING<br/>EVENT_VAL_BT_TRANSFERING</td>
+ * <td>#EVENT_KEY_BT_TRANSFERING_STATE</td>
+ * <td>#EVENT_VAL_BT_NON_TRANSFERING<br/>#EVENT_VAL_BT_TRANSFERING</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_LOCATION_ENABLE_STATE</td>
- * <td>EVENT_KEY_LOCATION_ENABLE_STATE</td>
- * <td>EVENT_VAL_LOCATION_DISABLED<br/>EVENT_VAL_LOCATION_ENABLED</td>
+ * <td>#SYSTEM_EVENT_LOCATION_ENABLE_STATE</td>
+ * <td>#EVENT_KEY_LOCATION_ENABLE_STATE</td>
+ * <td>#EVENT_VAL_LOCATION_DISABLED<br/>#EVENT_VAL_LOCATION_ENABLED</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_GPS_ENABLE_STATE</td>
- * <td>EVENT_KEY_GPS_ENABLE_STATE</td>
- * <td>EVENT_VAL_GPS_DISABLED<br/>EVENT_VAL_GPS_ENABLED</td>
+ * <td>#SYSTEM_EVENT_GPS_ENABLE_STATE</td>
+ * <td>#EVENT_KEY_GPS_ENABLE_STATE</td>
+ * <td>#EVENT_VAL_GPS_DISABLED<br/>#EVENT_VAL_GPS_ENABLED</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_NPS_ENABLE_STATE</td>
- * <td>EVENT_KEY_NPS_ENABLE_STATE</td>
- * <td>EVENT_VAL_NPS_DISABLED<br/>EVENT_VAL_NPS_ENABLED</td>
+ * <td>#SYSTEM_EVENT_NPS_ENABLE_STATE</td>
+ * <td>#EVENT_KEY_NPS_ENABLE_STATE</td>
+ * <td>#EVENT_VAL_NPS_DISABLED<br/>#EVENT_VAL_NPS_ENABLED</td>
* </tr>
* <tr>
- * <td rowspan="2">SYSTEM_EVENT_INCOMING_MSG</td>
- * <td>EVENT_KEY_MSG_TYPE</td>
- * <td>EVENT_VAL_SMS<br/>EVENT_VAL_PUSH<br/>EVENT_VAL_CB</td>
+ * <td rowspan="2">#SYSTEM_EVENT_INCOMING_MSG</td>
+ * <td>#EVENT_KEY_MSG_TYPE</td>
+ * <td>#EVENT_VAL_SMS<br/>#EVENT_VAL_PUSH<br/>#EVENT_VAL_CB</td>
* </tr>
* <tr>
- * <td>EVENT_KEY_MSG_ID</td>
+ * <td>#EVENT_KEY_MSG_ID</td>
* <td>string of unsigned int type value.</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_TIME_CHANGED</td>
+ * <td>#SYSTEM_EVENT_TIME_CHANGED</td>
* <td>N/A</td>
* <td>N/A</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_TIME_ZONE</td>
- * <td>EVENT_KEY_TIME_ZONE</td>
+ * <td>#SYSTEM_EVENT_TIME_ZONE</td>
+ * <td>#EVENT_KEY_TIME_ZONE</td>
* <td>The value of this key is timezone value of tz database, for example,<br/> "Asia/Seoul", "America/New_York",<br/>. Refer to the Time Zone Database of IANA.</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_HOUR_FORMAT</td>
- * <td>EVENT_KEY_HOUR_FORMAT</td>
- * <td>EVENT_VAL_HOURFORMAT_12<br/>EVENT_VAL_HOURFORMAT_24</td>
+ * <td>#SYSTEM_EVENT_HOUR_FORMAT</td>
+ * <td>#EVENT_KEY_HOUR_FORMAT</td>
+ * <td>#EVENT_VAL_HOURFORMAT_12<br/>#EVENT_VAL_HOURFORMAT_24</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_LANGUAGE_SET</td>
- * <td>EVENT_KEY_LANGUAGE_SET</td>
+ * <td>#SYSTEM_EVENT_LANGUAGE_SET</td>
+ * <td>#EVENT_KEY_LANGUAGE_SET</td>
* <td>The value of this key is full name of locale, for example,<br/> "ko_KR.UTF8" : in case of Korean language<br/> "en_US.UTF8" : in case of USA language,<br/>. Refer to linux locale info.</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_REGION_FORMAT</td>
- * <td>EVENT_KEY_REGION_FORMAT</td>
+ * <td>#SYSTEM_EVENT_REGION_FORMAT</td>
+ * <td>#EVENT_KEY_REGION_FORMAT</td>
* <td>The value of this key is full name of locale, for example,<br/> "ko_KR.UTF8" : in case of Korean region format<br/> "en_US.UTF8" : in case of USA region format,<br/>. Refer to linux locale info.</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_SILENT_MODE</td>
- * <td>EVENT_KEY_SILENT_MODE</td>
- * <td>EVENT_VAL_SILENTMODE_ON<br/>EVENT_VAL_SILENTMODE_OFF</td>
+ * <td>#SYSTEM_EVENT_SILENT_MODE</td>
+ * <td>#EVENT_KEY_SILENT_MODE</td>
+ * <td>#EVENT_VAL_SILENTMODE_ON<br/>#EVENT_VAL_SILENTMODE_OFF</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_VIBRATION_STATE</td>
- * <td>EVENT_KEY_VIBRATION_STATE</td>
- * <td>EVENT_VAL_VIBRATION_ON<br/>EVENT_VAL_VIBRATION_OFF</td>
+ * <td>#SYSTEM_EVENT_VIBRATION_STATE</td>
+ * <td>#EVENT_KEY_VIBRATION_STATE</td>
+ * <td>#EVENT_VAL_VIBRATION_ON<br/>#EVENT_VAL_VIBRATION_OFF</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_SCREEN_AUTOROTATE_STATE</td>
- * <td>EVENT_KEY_SCREEN_AUTOROTATE_STATE</td>
- * <td>EVENT_VAL_SCREEN_AUTOROTATE_ON<br/>EVENT_VAL_SCREEN_AUTOROTATE_OFF</td>
+ * <td>#SYSTEM_EVENT_SCREEN_AUTOROTATE_STATE</td>
+ * <td>#EVENT_KEY_SCREEN_AUTOROTATE_STATE</td>
+ * <td>#EVENT_VAL_SCREEN_AUTOROTATE_ON<br/>#EVENT_VAL_SCREEN_AUTOROTATE_OFF</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_MOBILE_DATA_STATE</td>
- * <td>EVENT_KEY_MOBILE_DATA_STATE</td>
- * <td>EVENT_VAL_MOBILE_DATA_OFF<br/>EVENT_VAL_MOBILE_DATA_ON</td>
+ * <td>#SYSTEM_EVENT_MOBILE_DATA_STATE</td>
+ * <td>#EVENT_KEY_MOBILE_DATA_STATE</td>
+ * <td>#EVENT_VAL_MOBILE_DATA_OFF<br/>#EVENT_VAL_MOBILE_DATA_ON</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_DATA_ROAMING_STATE</td>
- * <td>EVENT_KEY_DATA_ROAMING_STATE</td>
- * <td>EVENT_VAL_DATA_ROAMING_OFF<br/>EVENT_VAL_DATA_ROAMING_ON</td>
+ * <td>#SYSTEM_EVENT_DATA_ROAMING_STATE</td>
+ * <td>#EVENT_KEY_DATA_ROAMING_STATE</td>
+ * <td>#EVENT_VAL_DATA_ROAMING_OFF<br/>#EVENT_VAL_DATA_ROAMING_ON</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_FONT_SET</td>
- * <td>EVENT_KEY_FONT_SET</td>
+ * <td>#SYSTEM_EVENT_FONT_SET</td>
+ * <td>#EVENT_KEY_FONT_SET</td>
* <td>The value of this key is font name of string type by font-config.</td>
* </tr>
* <tr>
- * <td>SYSTEM_EVENT_NETWORK_STATUS</td>
- * <td>EVENT_KEY_NETWORK_STATUS</td>
- * <td>EVENT_VAL_NETWORK_DISCONNECTED<br/>EVENT_VAL_NETWORK_WIFI<br/>EVENT_VAL_NETWORK_CELLULAR<br/>EVENT_VAL_NETWORK_ETHERNET<br/>EVENT_VAL_NETWORK_BT<br/>EVENT_VAL_NETWORK_NET_PROXY</td>
+ * <td>#SYSTEM_EVENT_NETWORK_STATUS</td>
+ * <td>#EVENT_KEY_NETWORK_STATUS</td>
+ * <td>#EVENT_VAL_NETWORK_DISCONNECTED<br/>#EVENT_VAL_NETWORK_WIFI<br/>#EVENT_VAL_NETWORK_CELLULAR<br/>#EVENT_VAL_NETWORK_ETHERNET<br/>#EVENT_VAL_NETWORK_BT<br/>#EVENT_VAL_NETWORK_NET_PROXY</td>
* </tr>
* </table>
*/
diff --git a/doc/appfw_resource_manager_doc.h b/doc/appfw_resource_manager_doc.h
index 1e6375c..38cb989 100755
--- a/doc/appfw_resource_manager_doc.h
+++ b/doc/appfw_resource_manager_doc.h
@@ -50,19 +50,19 @@
* <th>Description</th>
* </tr>
* <tr>
- * <td>RSC_TYPE_IMAGE</td>
+ * <td>#APP_RESOURCE_TYPE_IMAGE</td>
* <td>Image resources.</td>
* </tr>
* <tr>
- * <td>RSC_TYPE_LAYOUT</td>
+ * <td>#APP_RESOURCE_TYPE_LAYOUT</td>
* <td>Application's layout to be displayed.</td>
* </tr>
* <tr>
- * <td>RSC_TYPE_SOUND</td>
+ * <td>#APP_RESOURCE_TYPE_SOUND</td>
* <td>Sound, audio resources.</td>
* </tr>
* <tr>
- * <td>RSC_TYPE_BIN</td>
+ * <td>#APP_RESOURCE_TYPE_BIN</td>
* <td>All other resources to be needed, but not specified above.</td>
* </tr>
* </table>