Proofread header file

Change-Id: Ia4e206d3ea8d0364d09d3c37ed1d411b91c23bfc
Signed-off-by: Kichan Kwon <k_c.kwon@samsung.com>

diff --git a/doc/system_info_doc.h b/doc/system_info_doc.h
index 8ca7345..3009589 100644 (file)
--- a/doc/system_info_doc.h
+++ b/doc/system_info_doc.h
@@ -18,20 +18,21 @@
 #ifndef __TIZEN_SYSTEM_SYSTEM_INFO_DOC_H__
 #define __TIZEN_SYSTEM_SYSTEM_INFO_DOC_H__
 
+
 /**
  * @ingroup CAPI_SYSTEM_FRAMEWORK
  * @defgroup CAPI_SYSTEM_SYSTEM_INFO_MODULE System Information
- * @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.
- *
+ * @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.
  * @section CAPI_SYSTEM_SYSTEM_INFO_MODULE_HEADER Required Header
- *   \#include <system_info.h>
+ * \#include <system_info.h>
  *
  * @section CAPI_SYSTEM_SYSTEM_INFO_MODULE_OVERVIEW Overview
  * 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.
- * The available system information is stored in key/value pairs. Depending on their respective key, values can have different data types.
+ * The available system information is stored in key/value pairs. Depending on their respective keys, values can have different data types.
  * 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>
- * 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.
- *
+ * 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 function.
  */
 
+
 #endif /* __TIZEN_SYSTEM_SYSTEM_INFO_DOC_H__ */

diff --git a/include/system_info.h b/include/system_info.h
index 4199ff0..fa62c71 100644 (file)
--- a/include/system_info.h
+++ b/include/system_info.h
@@ -25,164 +25,179 @@ extern "C"
 {
 #endif
 
+
 /**
  * @addtogroup CAPI_SYSTEM_SYSTEM_INFO_MODULE
  * @{
  */
 
+
 /**
- * @brief   Gets the boolean value of the @a platform feature.
+ * @brief Gets the boolean value of the @a platform feature.
  * @since_tizen 2.3
  * @param[in] key The name of the platform feature to get
  * @param[out] value The value of the given platform feature
- * @return  @c 0 on success,
- *          otherwise a negative error value
- * @retval  #SYSTEM_INFO_ERROR_NONE Successful
- * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval  #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
  */
 int system_info_get_platform_bool(const char *key, bool *value);
 
+
 /**
- * @brief   Gets the integer value of the @a platform feature.
+ * @brief Gets the integer value of the @a platform feature.
  * @since_tizen 2.3
  * @param[in] key The name of the platform feature to get
  * @param[out] value The value of the given platform feature
- * @return  @c 0 on success,
- *          otherwise a negative error value
- * @retval  #SYSTEM_INFO_ERROR_NONE Successful
- * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval  #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
  */
 int system_info_get_platform_int(const char *key, int *value);
 
+
 /**
- * @brief   Gets the double value of the @a platform feature.
+ * @brief Gets the double value of the @a platform feature.
  * @since_tizen 2.3
  * @param[in] key The name of the platform feature to get
  * @param[out] value The value of the given platform feature
- * @return  @c 0 on success,
- *          otherwise a negative error value
- * @retval  #SYSTEM_INFO_ERROR_NONE Successful
- * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval  #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
  */
 int system_info_get_platform_double(const char *key, double *value);
 
+
 /**
- * @brief   Gets the string value of the @a platform feature.
+ * @brief Gets the string value of the @a platform feature.
  * @since_tizen 2.3
  * @remarks You must release the @a value using free().
  * @param[in] key The name of the platform feature to get
  * @param[out] value The value of the given platform feature
- * @return  @c 0 on success,
- *          otherwise a negative error value
- * @retval  #SYSTEM_INFO_ERROR_NONE Successful
- * @retval  #SYSTEM_INFO_ERROR_OUT_OF_MEMORY Out of memory
- * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval  #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
  */
 int system_info_get_platform_string(const char *key, char **value);
 
 
 /**
- * @brief   Gets the boolean value of the @a custom feature.
+ * @brief Gets the boolean value of the @a custom feature.
  * @since_tizen 2.3
  * @param[in] key The name of the custom feature to get. NOTE: This custom function uses a custom key which is provided by OEM's
  * @param[out] value The value of the given custom feature
- * @return  @c 0 on success,
- *          otherwise a negative error value
- * @retval  #SYSTEM_INFO_ERROR_NONE Successful
- * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval  #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
  */
 int system_info_get_custom_bool(const char *key, bool *value);
 
+
 /**
- * @brief   Gets the integer value of the @a custom feature.
+ * @brief Gets the integer value of the @a custom feature.
  * @since_tizen 2.3
  * @param[in] key The name of the custom feature to get. NOTE: This custom function uses a custom key which is provided by OEM's
  * @param[out] value The value of the given custom feature
- * @return  @c 0 on success,
- *          otherwise a negative error value
- * @retval  #SYSTEM_INFO_ERROR_NONE Successful
- * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot the find @a key in the model config file
- * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval  #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot the find @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
  */
 int system_info_get_custom_int(const char *key, int *value);
 
+
 /**
- * @brief   Gets the double value of the @a custom feature.
+ * @brief Gets the double value of the @a custom feature.
  * @since_tizen 2.3
  * @param[in] key The name of the custom feature to get. NOTE: This custom function uses a custom key which is provided by OEM's
  * @param[out] value The value of the given custom feature
- * @return  @c 0 on success,
- *          otherwise a negative error value
- * @retval  #SYSTEM_INFO_ERROR_NONE Successful
- * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval  #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
  */
 int system_info_get_custom_double(const char *key, double *value);
 
+
 /**
- * @brief   Gets the string value of the @a custom feature.
+ * @brief Gets the string value of the @a custom feature.
  * @since_tizen 2.3
  * @remarks You must release the @a value using free().
  * @param[in] key The name of the custom feature to get. NOTE: This custom function uses a custom key which is provided by OEM's
  * @param[out] value The value of the given custom feature
- * @return  @c 0 on success,
- *          otherwise a negative error value
- * @retval  #SYSTEM_INFO_ERROR_NONE Successful
- * @retval  #SYSTEM_INFO_ERROR_OUT_OF_MEMORY Out of memory
- * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval  #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
  */
 int system_info_get_custom_string(const char *key, char **value);
 
+
 /**
  * @internal
- * @brief Do not use it. It will be removed
+ * @brief Do not use it. It will be removed.
  */
 int system_info_get_value_int(system_info_key_e key, int *value);
 
+
 /**
  * @internal
- * @brief Do not use it. It will be removed
+ * @brief Do not use it. It will be removed.
  */
 int system_info_get_value_bool(system_info_key_e key, bool *value);
 
+
 /**
  * @internal
- * @brief Do not use it. It will be removed
+ * @brief Do not use it. It will be removed.
  */
 int system_info_get_value_double(system_info_key_e key, double *value);
 
+
 /**
  * @internal
- * @brief Do not use it. It will be removed
+ * @brief Do not use it. It will be removed.
  */
 int system_info_get_value_string(system_info_key_e key, char **value);
 
+
 /**
  * @internal
- * @brief It is not decided if it should be opened to public
+ * @brief It is not decided if it should be opened to public.
  */
 int system_info_get_platform_type(const char *key, system_info_type_e *type);
 
+
 /**
  * @internal
- * @brief It is not decided if it should be opened to public
+ * @brief It is not decided if it should be opened to public.
  */
 int system_info_get_custom_type(const char *key, system_info_type_e *type);
 
+
 /**
  * @}
  */

diff --git a/include/system_info_type.h b/include/system_info_type.h
index 6e0cf0f..bbd2eab 100644 (file)
--- a/include/system_info_type.h
+++ b/include/system_info_type.h
@@ -25,26 +25,29 @@ extern "C"
 {
 #endif
 
+
 /**
  * @addtogroup CAPI_SYSTEM_SYSTEM_INFO_MODULE
  * @{
  */
 
+
 /**
- * @brief Enumeration of error codes for system information
+ * @brief Enumeration for system information error codes.
  */
 typedef enum {
-       SYSTEM_INFO_ERROR_NONE              = TIZEN_ERROR_NONE,          /**< Successful */
+       SYSTEM_INFO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
        SYSTEM_INFO_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
-       SYSTEM_INFO_ERROR_OUT_OF_MEMORY     = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
-       SYSTEM_INFO_ERROR_IO_ERROR          = TIZEN_ERROR_IO_ERROR,      /**< An input/output error occurred when reading value from system */
+       SYSTEM_INFO_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
+       SYSTEM_INFO_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< An input/output error occurred when reading value from system */
        SYSTEM_INFO_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< No permission to use the API */
-       SYSTEM_INFO_ERROR_NOT_SUPPORTED     = TIZEN_ERROR_NOT_SUPPORTED,     /**< Not supported parameter (Since 3.0) */
+       SYSTEM_INFO_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported parameter (Since 3.0) */
 } system_info_error_e;
 
+
 /**
  * @internal
- * @brief It is not decided if it should be opened to public
+ * @brief It is not decided if it should be opened to public.
  */
 typedef enum {
        SYSTEM_INFO_BOOL,
@@ -53,30 +56,30 @@ typedef enum {
        SYSTEM_INFO_STRING,
 } system_info_type_e;
 
+
 /**
  * @internal
- * @brief Enumeration of key for system information
+ * @brief Enumeration for system information key.
  */
 typedef enum {
-       SYSTEM_INFO_KEY_MODEL,                  /**< @internal The model of the device */
-       SYSTEM_INFO_KEY_TIZEN_VERSION,          /**< @internal The version of the Tizen API */
-       SYSTEM_INFO_KEY_PLATFORM_NAME,          /**< @internal The name of platform */
-       SYSTEM_INFO_KEY_TIZEN_VERSION_NAME,     /**< @internal The name of tizen version  */
-       SYSTEM_INFO_KEY_MANUFACTURER,           /**< @internal The manufacturer of the device */
-       SYSTEM_INFO_KEY_CORE_CPU_ARCH,          /**< @internal The CORE CPU architecture of model */
-       SYSTEM_INFO_KEY_CORE_CPU_FREQ,          /**< @internal The CORE CPU frequency of model */
-       SYSTEM_INFO_KEY_BUILD_STRING,           /**< @internal The build string of platform binary */
-       SYSTEM_INFO_KEY_BUILD_DATE,             /**< @internal The build date of platform binary */
-       SYSTEM_INFO_KEY_BUILD_TIME,             /**< @internal The build time of platform binary */
-       SYSTEM_INFO_KEY_SCREEN_HEIGHT,          /**< @internal The height of the screen in pixels */
-       SYSTEM_INFO_KEY_SCREEN_WIDTH,           /**< @internal The width of the screen in pixels */
+       SYSTEM_INFO_KEY_MODEL, /**< @internal The model of the device */
+       SYSTEM_INFO_KEY_TIZEN_VERSION, /**< @internal The version of the Tizen API */
+       SYSTEM_INFO_KEY_PLATFORM_NAME, /**< @internal The name of platform */
+       SYSTEM_INFO_KEY_TIZEN_VERSION_NAME, /**< @internal The name of tizen version  */
+       SYSTEM_INFO_KEY_MANUFACTURER, /**< @internal The manufacturer of the device */
+       SYSTEM_INFO_KEY_CORE_CPU_ARCH, /**< @internal The CORE CPU architecture of model */
+       SYSTEM_INFO_KEY_CORE_CPU_FREQ, /**< @internal The CORE CPU frequency of model */
+       SYSTEM_INFO_KEY_BUILD_STRING, /**< @internal The build string of platform binary */
+       SYSTEM_INFO_KEY_BUILD_DATE, /**< @internal The build date of platform binary */
+       SYSTEM_INFO_KEY_BUILD_TIME, /**< @internal The build time of platform binary */
+       SYSTEM_INFO_KEY_SCREEN_HEIGHT, /**< @internal The height of the screen in pixels */
+       SYSTEM_INFO_KEY_SCREEN_WIDTH, /**< @internal The width of the screen in pixels */
        SYSTEM_INFO_KEY_PHYSICAL_SCREEN_HEIGHT, /**< @internal The physical screen height in millimeters */
-       SYSTEM_INFO_KEY_PHYSICAL_SCREEN_WIDTH,  /**< @internal The physical screen width in millimeters */
-       SYSTEM_INFO_KEY_TETHERING_SUPPORTED,    /**< @internal Indicates whether the device supports tethering */
+       SYSTEM_INFO_KEY_PHYSICAL_SCREEN_WIDTH, /**< @internal The physical screen width in millimeters */
+       SYSTEM_INFO_KEY_TETHERING_SUPPORTED, /**< @internal Indicates whether the device supports tethering */
 } system_info_key_e;
 
 
-
 /**
  * @}
  */