doc/dlog_doc.h

   1 /*
   2  * Copyright (c) 2011 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 #ifndef __TIZEN_SYSTEM_DLOG_DOC_H__
  18 #define __TIZEN_SYSTEM_DLOG_DOC_H__
  19
  20 /**
  21  * @defgroup CAPI_SYSTEM_DLOG dlog
  22  * @brief The Dlog API provides functions for sending log output.
  23  * @ingroup CAPI_SYSTEM_FRAMEWORK
  24  * @section CAPI_SYSTEM_DLOG_HEADER Required Header
  25  *   \#include <dlog.h>
  26  *
  27  * @section CAPI_SYSTEM_DLOG_OVERVIEW Overview
  28  *
  29 Sending log message to circular buffer. dlog APIs include Priority and Tag. By using priority and Tag, we can easily filtered messages what we want to see.
  30 <h2 class="pg">priority</h2>
  31 priority level indicates the urgency of log message
  32
  33 <table>
  34 <tr>
  35         <th>Priority</th>
  36         <th>Description</th>
  37 </tr>
  38 <tr>
  39         <td>DLOG_DEBUG</td>
  40         <td>Debug messasge. - Log message which developer want to check.</td>
  41 </tr>
  42 <tr>
  43         <td>DLOG_INFO</td>
  44         <td>Information message - Normal operational messages. above of this priority will always be logged.</td>
  45 </tr>
  46 <tr>
  47         <td>DLOG_WARN</td>
  48         <td>Warning messages - Not an error, but indication that an error will occur if action is not taken.</td>
  49 </tr>
  50 <tr>
  51         <td>DLOG_ERROR</td>
  52         <td>Error message - Indicate error.</td>
  53 </tr>
  54 </table>
  55 *
  56 **/
  57 #endif /* __TIZEN_SYSTEM_DLOG_DOC_H__ */