include/system_info_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
  18 #ifndef __TIZEN_SYSTEM_SYSTEM_INFO_DOC_H__
  19 #define __TIZEN_SYSTEM_SYSTEM_INFO_DOC_H__
  20
  21 /**
  22  * @defgroup CAPI_SYSTEM_SYSTEM_INFO_MODULE SYSTEM_INFO
  23  * @brief  The System Information API provides functions to obtain information about devices.
  24  * @ingroup CAPI_SYSTEM_SYSTEM_INFO
  25  *
  26  * @section CAPI_SYSTEM_SYSTEM_INFO_MODULE_HEADER Required Header
  27  *   \#include <system_info.h>
  28  *
  29  * @section CAPI_SYSTEM_SYSTEM_INFO_MODULE_OVERVIEW Overview
  30  * The System Information API provides functions to obtain information about the device such as the API and platform versions, device model, supported device features, and screen dimensions.
  31  * The system information available is stored in key/value pairs, where there may be different data types for the value.
  32  *
  33  * To read a value, use the appropriate function, one of system_info_get_value_int(), system_info_get_value_bool(), system_info_get_value_double() or system_info_get_value_string().
  34 *
  35 */
  36
  37 #endif /* __TIZEN_SYSTEM_SYSTEM_INFO_DOC_H__ */