From: 오형석/On-Device Lab(SR)/Staff Engineer/삼성전자 <hseok82.oh@samsung.com>
Date: Wed, 27 Nov 2019 01:41:45 +0000 (+0900)
Subject: [runtime/api] Update nnfw_create_session comment (#9228)
X-Git-Tag: submit/tizen/20191205.083104~104
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e8cd82ee532cb291472f39453552de41a10822c1;p=platform%2Fcore%2Fml%2Fnnfw.git

[runtime/api] Update nnfw_create_session comment (#9228)

* [runtime/api] Update nnfw_create_session comment

- Fix doxygen format
- Add more comment

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

* Fix comment
---

diff --git a/runtime/neurun/api/include/nnfw.h b/runtime/neurun/api/include/nnfw.h
index 9c80d02..cfc6ce7 100644
--- a/runtime/neurun/api/include/nnfw.h
+++ b/runtime/neurun/api/include/nnfw.h
@@ -102,11 +102,18 @@ typedef struct nnfw_tensorinfo
   int dims[6];
 } nnfw_tensorinfo;
 
-/*
- * Create a new session instance
+/**
+ * Create a new session instance.
  *
- * @param[out] session the session to be created
- * @return NNFW_STATUS_NO_ERROR if successful
+ * <p>This only creates a session.
+ * Model is loaded after {@link nnfw_load_model_from_file} is invoked.
+ * And inference is performed after {@link nnfw_run} is invoked.
+ *
+ * <p>{@link nnfw_close_session} should be called once
+ * if session is no longer need
+ *
+ * @param[out]  session The session to be created
+ * @return      @c NNFW_STATUS_NO_ERROR if successful
  */
 NNFW_STATUS nnfw_create_session(nnfw_session **session);