[C-API] Fix C-API header comments

Clarify the description of nnstreamer C-API comments

Signed-off-by: Gichan Jang <gichan2.jang@samsung.com>

diff --git a/api/capi/include/nnstreamer-single.h b/api/capi/include/nnstreamer-single.h
index 77e5bf2..25ec39f 100644 (file)
--- a/api/capi/include/nnstreamer-single.h
+++ b/api/capi/include/nnstreamer-single.h
@@ -76,7 +76,7 @@ typedef void *ml_single_h;
 int ml_single_open (ml_single_h *single, const char *model, const ml_tensors_info_h input_info, const ml_tensors_info_h output_info, ml_nnfw_type_e nnfw, ml_nnfw_hw_e hw);
 
 /**
- * @brief Opens an ML model and returns the instance as a handle.
+ * @brief Opens an ML model and returns the instance as a handle with custom options.
  * @details Even if the model has flexible input data dimensions,
  *          input data frames of an instance of a model should share the same dimension.
  * @since_tizen 6.5
@@ -96,9 +96,9 @@ int ml_single_open (ml_single_h *single, const char *model, const ml_tensors_inf
  * @param[in] hw Tell the corresponding @a nnfw to use a specific hardware.
  *               Set #ML_NNFW_HW_ANY if it does not matter.
  * @param[in] custom_option Comma separated list of options.
- *                      It is necessary to optimize the control for some neural network framework. (e.g. NumThreads:N to set the number of threads in TensorFlow-Lite)
+ *                      Use this parameter to fine-tune and optimize specific neural network framework. (e.g. NumThreads:N to set the number of threads in TensorFlow-Lite)
  *                      You may set NULL if it's not required.
- *                      See NNStreamer (https://github.com/nnstreamer/nnstreamer) documentation for the details.
+ *                      See NNStreamer documentation (https://nnstreamer.github.io/gst/nnstreamer/tensor_filter/README.html) for the details.
  * @return @c 0 on success. Otherwise a negative error value.
  * @retval #ML_ERROR_NONE Successful.
  * @retval #ML_ERROR_NOT_SUPPORTED Not supported.

diff --git a/api/capi/include/nnstreamer.h b/api/capi/include/nnstreamer.h
index 9bea355..3db070c 100644 (file)
--- a/api/capi/include/nnstreamer.h
+++ b/api/capi/include/nnstreamer.h
@@ -1231,7 +1231,7 @@ int ml_tensors_data_set_tensor_data (ml_tensors_data_h data, unsigned int index,
 int ml_check_nnfw_availability (ml_nnfw_type_e nnfw, ml_nnfw_hw_e hw, bool *available);
 
 /**
- * @brief Checks the element is registered and available on the pipeline.
+ * @brief Checks if the element is registered and available on the pipeline.
  * @details If the function returns an error, @a available may not be changed.
  * @since_tizen 6.5
  * @param[in] element_name The name of element.