Fix doxygen description

- Fix typos
- Add '#' to become an anchor to its definition

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

diff --git a/include/runtime_info.h b/include/runtime_info.h
index 39592be..566b8f2 100644 (file)
--- a/include/runtime_info.h
+++ b/include/runtime_info.h
@@ -253,7 +253,7 @@ typedef struct {
 
 
 /**
 
 
 /**

- * @brief        Gets system memory information in the form of runtime_memory_info_s.
+ * @brief        Gets system memory information in the form of #runtime_memory_info_s.

  * @details      The information is collected from /proc/meminfo.
  * @since_tizen  2.4
  *
  * @details      The information is collected from /proc/meminfo.
  * @since_tizen  2.4
  *


@@ -286,7 +286,7 @@ typedef struct {
 
 
 /**
 
 
 /**

- * @brief        Gets memory information per process in the form of process_memory_info_s.
+ * @brief        Gets memory information per process in the form of #process_memory_info_s.

  * @details      The information is collected from /proc/[pid]/stat and /proc/[pid]/smaps.
  * @since_tizen  2.4
  *
  * @details      The information is collected from /proc/[pid]/stat and /proc/[pid]/smaps.
  * @since_tizen  2.4
  *


@@ -326,7 +326,7 @@ typedef struct {
 
 
 /**
 
 
 /**

- * @brief        Gets CPU usgae information in the form of runtime_cpu_usage_s.
+ * @brief        Gets CPU usgae information in the form of #runtime_cpu_usage_s.

  * @details      The information is collected from /proc/stat.
  * @since_tizen  2.4
  *
  * @details      The information is collected from /proc/stat.
  * @since_tizen  2.4
  *


@@ -354,7 +354,7 @@ typedef struct {
 
 
 /**
 
 
 /**

- * @brief        Gets CPU usage in the form of process_cpu_usage_s.
+ * @brief        Gets CPU usage in the form of #process_cpu_usage_s.

  * @details      The information is collected from /proc/[pid]/stat.
  * @since_tizen  2.4
  *
  * @details      The information is collected from /proc/[pid]/stat.
  * @since_tizen  2.4
  *


@@ -457,8 +457,8 @@ typedef struct app_usages_s *app_usage_h;
 
 
 /**
 
 
 /**

- * @brief        Destroy app_usage_h that won't be used anymore.
- * @details      Destroy app_usage_h acquired by functions runtime_info_get_all_apps_memory_usage()
+ * @brief        Destroy #app_usage_h that won't be used anymore.
+ * @details      Destroy #app_usage_h acquired by functions runtime_info_get_all_apps_memory_usage()

  *               or runtime_info_get_all_apps_cpu_rate().
  * @since_tizen  4.0
  *
  *               or runtime_info_get_all_apps_cpu_rate().
  * @since_tizen  4.0
  *


@@ -476,8 +476,8 @@ int runtime_info_app_usage_destroy(app_usage_h handle);
 
 
 /**
 
 
 /**

- * @brief        Gets the number of applications that app_usage_h has retrieved.
- * @details      Gets only applications that are managed by <a href=""https://docs.tizen.org/application/native/guides/app-management/app-manager/>Application Manager</a>.
+ * @brief        Gets the number of applications that #app_usage_h has retrieved.
+ * @details      Gets only applications that are managed by <a href="https://docs.tizen.org/application/native/guides/app-management/app-manager/">Application Manager</a>.

  * @since_tizen  4.0
  *
  * @param[in]  handle  The app usage handle
  * @since_tizen  4.0
  *
  * @param[in]  handle  The app usage handle


@@ -495,8 +495,8 @@ int runtime_info_app_usage_get_count(app_usage_h handle, int *count);
 
 
 /**
 
 
 /**

- * @brief        Gets an application ID by index from an app_usage_h.
- * @details      Gets only applications that are managed by <a href=""https://docs.tizen.org/application/native/guides/app-management/app-manager/>Application Manager</a>.
+ * @brief        Gets an application ID by index from an #app_usage_h.
+ * @details      Gets only applications that are managed by <a href="https://docs.tizen.org/application/native/guides/app-management/app-manager/">Application Manager</a>.

  * @since_tizen  4.0
  *
  * @remarks  You must release @a appid using free().
  * @since_tizen  4.0
  *
  * @remarks  You must release @a appid using free().


@@ -518,10 +518,10 @@ int runtime_info_app_usage_get_appid(app_usage_h handle, int index, char **appid
 
 
 /**
 
 
 /**

- * @brief        Gets resource usage of an application by index from an app_usage_h.
+ * @brief        Gets resource usage of an application by index from an #app_usage_h.

  * @details      Counts memory that is exclusively used by an application. That is, it doesn't
  *               count shared memory of an application such as file or shared library, etc.
  * @details      Counts memory that is exclusively used by an application. That is, it doesn't
  *               count shared memory of an application such as file or shared library, etc.

- *               Gets only applications that are managed by <a href=""https://docs.tizen.org/application/native/guides/app-management/app-manager/>Application Manager</a>.
+ *               Gets only applications that are managed by <a href="https://docs.tizen.org/application/native/guides/app-management/app-manager/">Application Manager</a>.

  * @since_tizen  4.0
  *
  * @remarks  The meaning of @a usage depends on which function was used to create @a handle.
  * @since_tizen  4.0
  *
  * @remarks  The meaning of @a usage depends on which function was used to create @a handle.


@@ -543,10 +543,10 @@ int runtime_info_app_usage_get_usage(app_usage_h handle, int index, unsigned int
 
 
 /**
 
 
 /**

- * @brief        Gets memory usage of all applications in kilobyte into app_usage_h.
+ * @brief        Gets memory usage of all applications in kilobyte into #app_usage_h.

  * @details      Counts memory that is exclusively used by an application. That is, it doesn't
  *               count shared memory of an application such as file or shared library, etc.
  * @details      Counts memory that is exclusively used by an application. That is, it doesn't
  *               count shared memory of an application such as file or shared library, etc.

- *               Gets only applications that are managed by <a href=""https://docs.tizen.org/application/native/guides/app-management/app-manager/>Application Manager</a>.
+ *               Gets only applications that are managed by <a href="https://docs.tizen.org/application/native/guides/app-management/app-manager/">Application Manager</a>.

  * @since_tizen  4.0
  *
  * @privlevel  public
  * @since_tizen  4.0
  *
  * @privlevel  public


@@ -595,9 +595,9 @@ int runtime_info_get_all_apps_memory_usage(app_usage_h *usage);
 
 
 /**
 
 
 /**

- * @brief        Gets CPU rate of all applications in kilobyte into app_usage_h.
- * @detail       The information is collected from /proc/[pid]/stat.
- *               Gets only applications that are managed by <a href=""https://docs.tizen.org/application/native/guides/app-management/app-manager/>Application Manager</a>.
+ * @brief        Gets CPU rate of all applications in kilobyte into #app_usage_h.
+ * @details      The information is collected from /proc/[pid]/stat.
+ *               Gets only applications that are managed by <a href="https://docs.tizen.org/application/native/guides/app-management/app-manager/">Application Manager</a>.

  * @since_tizen  4.0
  *
  * @privlevel  public
  * @since_tizen  4.0
  *
  * @privlevel  public


@@ -653,4 +653,4 @@ int runtime_info_get_all_apps_cpu_rate(app_usage_h *rate);
 }
 #endif
 
 }
 #endif
 

-#endif /** __TIZEN_SYSTEM_RUNTIME_INFO_H__ */
+#endif /* __TIZEN_SYSTEM_RUNTIME_INFO_H__ */