doc/system_info_doc.h

   1 /*
   2  * Copyright (c) 2014 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  * @ingroup CAPI_SYSTEM_FRAMEWORK
  23  * @defgroup CAPI_SYSTEM_SYSTEM_INFO_MODULE System Information
  24  * @brief  The System Information API provides functions which can be used to obtain device information. This section provides more information about the System Information API.
  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 which can be used to obtain system information such as the device API and platform versions, device model number, supported device features, and device screen dimensions.
  31  * The available system information is stored in key/value pairs. Depending on their respective key, values can have different data types.
  32  * The keys for the platform functions are specified by the Tizen platform and can be seen <a href="https://developer.tizen.org/development/guides/native-application/system/system-information">here.</a>
  33  * The keys for the custom functions are specified by OEM's and vendors. Developers should check with their OEM's Tizen OS support if they wish to use a custom functions.
  34  *
  35  */
  36
  37 #endif /* __TIZEN_SYSTEM_SYSTEM_INFO_DOC_H__ */