Elaborate doxygen description of header file

Change-Id: I6fbec491e8f779eb5effb1f9b900fbe57068023f
Signed-off-by: Youngjae Cho <y0.cho@samsung.com>

diff --git a/include/system_info.h b/include/system_info.h
index fa62c71..02dbfe6 100644 (file)
--- a/include/system_info.h
+++ b/include/system_info.h
@@ -33,7 +33,8 @@ extern "C"
 
 
 /**
- * @brief Gets the boolean value of the @a platform feature.
+ * @brief Gets the boolean type value of the @a platform feature.
+ * @details The keys for the platform functions are specified by the Tizen platform and can be seen <a href="https://docs.tizen.org/application/native/guides/device/system">here.</a>
  * @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
@@ -48,7 +49,8 @@ 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 type value of the @a platform feature.
+ * @details The keys for the platform functions are specified by the Tizen platform and can be seen <a href="https://docs.tizen.org/application/native/guides/device/system">here.</a>
  * @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
@@ -63,7 +65,8 @@ 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 type value of the @a platform feature.
+ * @details The keys for the platform functions are specified by the Tizen platform and can be seen <a href="https://docs.tizen.org/application/native/guides/device/system">here.</a>
  * @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
@@ -78,7 +81,8 @@ 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 type value of the @a platform feature.
+ * @details The keys for the platform functions are specified by the Tizen platform and can be seen <a href="https://docs.tizen.org/application/native/guides/device/system">here.</a>
  * @since_tizen 2.3
  * @remarks You must release the @a value using free().
  * @param[in] key The name of the platform feature to get
@@ -95,9 +99,10 @@ 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 type value of the @a custom feature.
+ * @details This custom function uses a custom key which is provided by OEM's.
  * @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[in] key The name of the custom feature to get.
  * @param[out] value The value of the given custom feature
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -110,9 +115,10 @@ 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 type value of the @a custom feature.
+ * @details This custom function uses a custom key which is provided by OEM's.
  * @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[in] key The name of the custom feature to get.
  * @param[out] value The value of the given custom feature
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -125,9 +131,10 @@ 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 type value of the @a custom feature.
+ * @details This custom function uses a custom key which is provided by OEM's.
  * @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[in] key The name of the custom feature to get.
  * @param[out] value The value of the given custom feature
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -140,10 +147,11 @@ 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 type value of the @a custom feature.
+ * @details This custom function uses a custom key which is provided by OEM's.
  * @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[in] key The name of the custom feature to get.
  * @param[out] value The value of the given custom feature
  * @return @c 0 on success,
  *         otherwise a negative error value