[runtime/api] Update load and run comment (#9298)

- Fix doxygen format
- Add more comment for nnfw_run

Signed-off-by: Hyeongseok Oh <hseok82.oh@samsung.com>

diff --git a/runtime/neurun/api/include/nnfw.h b/runtime/neurun/api/include/nnfw.h
index 2dcc219..730ad4b 100644 (file)
--- a/runtime/neurun/api/include/nnfw.h
+++ b/runtime/neurun/api/include/nnfw.h
@@ -152,13 +152,13 @@ NNFW_STATUS nnfw_create_session(nnfw_session **session);
  */
 NNFW_STATUS nnfw_close_session(nnfw_session *session);
 
-/*
- * Load model from nnpackage file or directory
+/**
+ * @brief     Load model from nnpackage file or directory
  *
- * @param[in] session nnfw_session loading the given nnpackage file/dir
- * @param[in] package_file_path path to the nnpackage file or unzipped directory to be loaded
+ * @param[in] session           nnfw_session loading the given nnpackage file/dir
+ * @param[in] package_file_path Path to the nnpackage file or unzipped directory to be loaded
  *
- * @return NNFW_STATUS_NO_ERROR if successful
+ * @return    @c NNFW_STATUS_NO_ERROR if successful
  */
 NNFW_STATUS nnfw_load_model_from_file(nnfw_session *session, const char *package_file_path);
 
@@ -190,11 +190,17 @@ NNFW_STATUS nnfw_apply_tensorinfo(nnfw_session *session, uint32_t index,
  */
 NNFW_STATUS nnfw_prepare(nnfw_session *session);
 
-/*
- * Run inference
+/**
+ * @brief     Run inference
  *
- * @param[in] session the session to run inference
- * @return NNFW_STATUS_NO_ERROR if successful
+ * <p>This function should be called after model is loaded by {@link nnfw_load_model_from_file},
+ * session is prepared for inference by {@link nnfw_prepare}, set input and output buffers
+ * by {@link nnfw_set_input} and {@link nnfw_set_output}.</p>
+ *
+ * <p>This function return after inference is finished.</p>
+ *
+ * @param[in] session The session to run inference
+ * @return    @c NNFW_STATUS_NO_ERROR if successful
  */
 NNFW_STATUS nnfw_run(nnfw_session *session);