doc/notification_doc.h

   1 /*
   2  *  libnotification
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Seungtaek Chung <seungtaek.chung@samsung.com>, Mi-Ju Lee <miju52.lee@samsung.com>, Xi Zhichan <zhichan.xi@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  */
  21
  22 /**
  23  *
  24  * @defgroup NOTIFICATION_MODULE Notification
  25  * @ingroup CAPI_APPLICATION_FRAMEWORK
  26  * @brief Notification APIs
  27  *
  28  * @section NOTIFICATION_MODULE_HEADER Required Header
  29  *   \#include <notification.h>
  30  * @section NOTIFICATION_MODULE_OVERVIEW Overview
  31  * A notification is a message that is displayed on the notification area or the on-going area.
  32  * It is created to notify information to the user through the application.
  33  * This API provides functions for creating and inserting and updating notification.
  34  *
  35  */
  36
  37 /**
  38  * @internal
  39  * @defgroup NOTIFICATION_LIST Notification List
  40  * @ingroup NOTIFICATION_MODULE
  41  * @brief linked list of notification data
  42  *
  43  * @section NOTIFICATION_LIST_MODULE_HEADER Required Header
  44  *   \#include <notification.h>
  45  * @section NOTIFICATION_LIST_MODULE_OVERVIEW Overview
  46  * It provides functions for handling notification list.
  47  *
  48  */
  49
  50 /**
  51  * @defgroup NOTIFICATION_STATUS Notification Status
  52  * @ingroup NOTIFICATION_MODULE
  53  * @brief APIs displaying plain text message on the indicator area
  54  *
  55  * @section NOTIFICATION_STATUS_MODULE_HEADER Required Header
  56  *   \#include <notification.h>
  57  * @section NOTIFICATION_STATUS_MODULE_OVERVIEW Overview
  58  * Notification status APIs
  59  *
  60  */
  61