From e8cd82ee532cb291472f39453552de41a10822c1 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=EC=98=A4=ED=98=95=EC=84=9D/On-Device=20Lab=28SR=29/Staff?= =?utf8?q?=20Engineer/=EC=82=BC=EC=84=B1=EC=A0=84=EC=9E=90?= Date: Wed, 27 Nov 2019 10:41:45 +0900 Subject: [PATCH] [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 * Fix comment --- runtime/neurun/api/include/nnfw.h | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) 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 + *

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. + * + *

{@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); -- 2.7.4