--- /dev/null
+/*
+ * libbadge
+ *
+ * Copyright (c) 2000 - 2015 Samsung Electronics Co., Ltd. All rights reserved.
+ *
+ * Contact: Youngjoo Park <yjoo93.park@samsung.com>,
+ * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+/**
+ *
+ * @defgroup BADGE_MODULE Badge
+ * @ingroup CAPI_APPLICATION_FRAMEWORK
+ * @brief Badge APIs
+ *
+ * @section BADGE_MODULE_HEADER Required Header
+ * \#include <badge.h>
+ * @section BADGE_MODULE_OVERVIEW Overview
+ * It provides functions for creating and inserting and updating badge.
+ *
+ */
/**
* @internal
* @brief Enumeration for Badge Action.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
enum badge_action {
BADGE_ACTION_CREATE = 0, /**< @internal Badge created */
/**
* @internal
* @brief Called to retrieve the badge existence.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] app_id The name of the application
* @param[in] count The count of the badge
* @param[in] data The user data passed from the foreach function
/**
* @internal
* @brief Called when the badge information is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] action The type of the change
* @param[in] app_id The name of the application
* @param[in] count The count of the badge
/**
* @internal
* @brief Retrieves all existing badges.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] callback The callback function
/**
* @internal
* @brief Registers a callback function to receive badge change event.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] callback The callback function
/**
* @internal
* @brief Unregisters a callback function to receive badge change event.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] callback The callback function
/**
* @internal
* @brief This function checks whether badge service is ready
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
/**
* @internal
* @brief This function adds deferred task. the registered task will be executed when badge service become ready
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] badge_add_deferred_task The callback function
/**
* @internal
* @brief This function removes deferred task.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] badge_add_deferred_task The callback function
/**
* @brief Creates a badge for the application itself.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @details Creates new badge to display.
/**
* @brief Removes the badge for the designated application.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] app_id The name of the designated application
/**
* @brief Sets badge count for the designated application.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] app_id The name of the designated application
/**
* @brief Gets badge count for the designated application.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] app_id The name of the designated application
/**
* @brief Sets the display option for the designated application.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] app_id The name of the designated application
/**
* @brief Gets the display option for the designated application.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] app_id The name of the designated application
/**
* @internal
* @brief Tests if the badge for the designated application exists or not.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] app_id The name of the designated application