doc/notification_doc.h

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