Release version 0.5.73

[platform/core/api/notification.git] / doc / notification_doc.h

diff --git a/doc/notification_doc.h b/doc/notification_doc.h
old mode 100755 (executable)
new mode 100644 (file)
index a767e1b..83ae4dd
--- a/doc/notification_doc.h
+++ b/doc/notification_doc.h
@@ -1,9 +1,5 @@
 /*
- *  libnotification
- *
- * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
- *
- * Contact: Seungtaek Chung <seungtaek.chung@samsung.com>, Mi-Ju Lee <miju52.lee@samsung.com>, Xi Zhichan <zhichan.xi@samsung.com>
+ * Copyright (c) 2000 - 2016 Samsung Electronics Co., Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,49 +12,44 @@
  * 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.
- *
  */
 
+
 /**
- *
- * @ingroup NOTIFICATION_LIBRARY
- * @defgroup NOTIFICATION_MODULE notification APIs
- * @brief Notification APIs
- *
+ * @ingroup CAPI_APPLICATION_FRAMEWORK
+ * @defgroup NOTIFICATION_MODULE Notification
+ * @brief Notification APIs.
  * @section NOTIFICATION_MODULE_HEADER Required Header
  *   \#include <notification.h>
- * @section NOTIFICATION_MODULE_OVERVIEW Overview
- * It provides functions for creating and inserting and updating notification.
- *
- * @ingroup NOTIFICATION_LIBRARY
- * @defgroup NOTIFICATION_LIST notification list APIs
- * @brief linked list of notification data
  *
+ * @section NOTIFICATION_MODULE_OVERVIEW Overview
+ * A notification is a message that is displayed on the notification area or the ongoing area.
+ * It is created to notify information to the user through the application.
+ * This API provides functions for creating, inserting and updating notification.
+ */
+
+
+/**
+ * @internal
+ * @ingroup NOTIFICATION_MODULE
+ * @defgroup NOTIFICATION_LIST Notification List
+ * @brief Linked list of notification data.
  * @section NOTIFICATION_LIST_MODULE_HEADER Required Header
- *   \#include <notification_list.h>
- * @section NOTIFICATION_LIST_MODULE_OVERVIEW Overview
- * It provides functions for handling
+ *   \#include <notification.h>
  *
- * @ingroup NOTIFICATION_LIBRARY
- * @defgroup NOTIFICATION_STATUS notification status APIs
- * @brief APIs displaying plain text message on the indicator area
+ * @section NOTIFICATION_LIST_MODULE_OVERVIEW Overview
+ * It provides functions for handling notification list.
  *
+ */
+
+
+/**
+ * @ingroup NOTIFICATION_MODULE
+ * @defgroup NOTIFICATION_STATUS Notification Status
+ * @brief APIs displaying plain text message on the indicator area.
  * @section NOTIFICATION_STATUS_MODULE_HEADER Required Header
- *   \#include <notification_status.h>
- * @section NOTIFICATION_STATUS_MODULE_OVERVIEW Overview
- * Notification status APIs
- *
- * @ingroup NOTIFICATION_LIBRARY
- * @defgroup NOTIFICATION_TYPE notification type
- * @brief Type for notification APIs
- *
- * @section NOTIFICATION_TYPE_MODULE_HEADER Required Header
- *   \#include <notification_type.h>
- * @section NOTIFICATION_TYPE_MODULE_OVERVIEW Overview
- * Type defines and enumerations for Notification APIs
- *
- * @ingroup NOTIFICATION_LIBRARY
- * @defgroup NOTIFICATION_DEPRECATED deprecated APIs
- * @brief deprecated APIs
+ *   \#include <notification.h>
  *
+ * @section NOTIFICATION_STATUS_MODULE_OVERVIEW Overview
+ * Notification status APIs.
  */