doc/badge_doc.h

   1 /*
   2  *  libbadge
   3  *
   4  * Copyright (c) 2000 - 2015 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Youngjoo Park <yjoo93.park@samsung.com>,
   7  *      Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com>
   8  *
   9  * Licensed under the Apache License, Version 2.0 (the License);
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  * http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an AS IS BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  */
  22
  23
  24 /**
  25  * @ingroup CAPI_APPLICATION_FRAMEWORK
  26  * @defgroup BADGE_MODULE Badge
  27  * @brief Badge APIs.
  28  * @section BADGE_MODULE_HEADER Required Header
  29  * \#include <badge.h>
  30  *
  31  * @section BADGE_MODULE_OVERVIEW Overview
  32  * It provides functions for creating and inserting and updating badge.
  33  *
  34  * @section CAPI_BADGE_MODULE_FEATURE Related Features
  35  * This API is related with the following features:\n
  36  * - %http://tizen.org/feature/badge\n
  37  *
  38  * It is recommended to design feature related codes in your application for reliability.\n
  39  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  40  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  41  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
  42  */