doc/badge_doc.h

   1 /*
   2  *  libbadge
   3  *
   4  * Copyright (c) 2000 - 2012 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 BADGE_LIBRARY
  26  * @defgroup BADGE_MODULE badge APIs
  27  * @brief Badge APIs
  28  *
  29  * @section BADGE_MODULE_HEADER Required Header
  30  *   \#include <badge.h>
  31  * @section BADGE_MODULE_OVERVIEW Overview
  32  * It provides functions for creating and inserting and updating badge.
  33  *
  34  * @ingroup BADGE_LIBRARY
  35  * @defgroup BADGE_TYPE badge type
  36  * @brief Type for badge APIs
  37  *
  38  * @section BADGE_TYPE_MODULE_HEADER Required Header
  39  *   \#include <badge.h>
  40  *   \#include <badge_error.h>
  41  * @section BADGE_TYPE_MODULE_OVERVIEW Overview
  42  * Type defines and enumerations for Badge APIs
  43  *
  44  */