[Api] update api description

Fix typo and update details about the APIs.

Signed-off-by: Jaeyun Jung <jy1210.jung@samsung.com>

diff --git a/api/capi/include/nnstreamer-single.h b/api/capi/include/nnstreamer-single.h
index 468850f..51f7b6e 100644 (file)
--- a/api/capi/include/nnstreamer-single.h
+++ b/api/capi/include/nnstreamer-single.h
@@ -69,7 +69,7 @@ typedef void *ml_single_h;
  *                 Set #ML_NNFW_TYPE_ANY to let it auto-detect.
  * @param[in] hw Tell the corresponding @a nnfw to use a specific hardware.
  *               Set #ML_NNFW_HW_ANY if it does not matter.
- * @return @c 0 on success. otherwise a negative error value
+ * @return @c 0 on success. Otherwise a negative error value.
  * @retval #ML_ERROR_NONE Successful
  * @retval #ML_ERROR_NOT_SUPPORTED Not supported.
  * @retval #ML_ERROR_INVALID_PARAMETER Fail. The parameter is invalid.
@@ -81,7 +81,7 @@ int ml_single_open (ml_single_h *single, const char *model, const ml_tensors_inf
  * @brief Closes the opened model handle.
  * @since_tizen 5.5
  * @param[in] single The model handle to be closed.
- * @return @c 0 on success. otherwise a negative error value
+ * @return @c 0 on success. Otherwise a negative error value.
  * @retval #ML_ERROR_NONE Successful
  * @retval #ML_ERROR_NOT_SUPPORTED Not supported.
  * @retval #ML_ERROR_INVALID_PARAMETER Fail. The parameter is invalid (pipe is NULL?)
@@ -97,7 +97,7 @@ int ml_single_close (ml_single_h single);
  * @param[in] single The model handle to be inferred.
  * @param[in] input The input data to be inferred.
  * @param[out] output The allocated output buffer. The caller is responsible for freeing the output buffer with ml_tensors_data_destroy().
- * @return @c 0 on success. otherwise a negative error value.
+ * @return @c 0 on success. Otherwise a negative error value.
  * @retval #ML_ERROR_NONE Successful
  * @retval #ML_ERROR_NOT_SUPPORTED Not supported.
  * @retval #ML_ERROR_INVALID_PARAMETER Fail. The parameter is invalid.
@@ -118,7 +118,7 @@ int ml_single_invoke (ml_single_h single, const ml_tensors_data_h input, ml_tens
  * @since_tizen 5.5
  * @param[in] single The model handle.
  * @param[out] info The handle of input tensors information. The caller is responsible for freeing the information with ml_tensors_info_destroy().
- * @return @c 0 on success. otherwise a negative error value.
+ * @return @c 0 on success. Otherwise a negative error value.
  * @retval #ML_ERROR_NONE Successful
  * @retval #ML_ERROR_NOT_SUPPORTED Not supported.
  * @retval #ML_ERROR_INVALID_PARAMETER Fail. The parameter is invalid.
@@ -132,7 +132,7 @@ int ml_single_get_input_info (ml_single_h single, ml_tensors_info_h *info);
  * @since_tizen 5.5
  * @param[in] single The model handle.
  * @param[out] info The handle of output tensors information. The caller is responsible for freeing the information with ml_tensors_info_destroy().
- * @return @c 0 on success. otherwise a negative error value.
+ * @return @c 0 on success. Otherwise a negative error value.
  * @retval #ML_ERROR_NONE Successful
  * @retval #ML_ERROR_NOT_SUPPORTED Not supported.
  * @retval #ML_ERROR_INVALID_PARAMETER Fail. The parameter is invalid.

diff --git a/api/capi/include/nnstreamer.h b/api/capi/include/nnstreamer.h
index 3e41752..61c5bbd 100644 (file)
--- a/api/capi/include/nnstreamer.h
+++ b/api/capi/include/nnstreamer.h
@@ -678,6 +678,7 @@ int ml_tensors_data_destroy (ml_tensors_data_h data);
 
 /**
  * @brief Gets a tensor data of given handle.
+ * @details This returns the pointer of memory block in the handle. Do not deallocate the returned tensor data.
  * @since_tizen 5.5
  * @param[in] data The handle of tensors data.
  * @param[in] index The index of the tensor.