From: Jaeyun <jy1210.jung@samsung.com>
Date: Fri, 12 Jun 2020 09:18:50 +0000 (+0900)
Subject: [Doc] fix invalid document
X-Git-Tag: accepted/tizen/unified/20200629.143505~37
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=9164b7722c3bac1cf4b8c329282721ded1517bb5;p=platform%2Fupstream%2Fnnstreamer.git

[Doc] fix invalid document

typo correction and fix document for converter sub-plugin api.

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

diff --git a/gst/nnstreamer/include/nnstreamer_plugin_api_converter.h b/gst/nnstreamer/include/nnstreamer_plugin_api_converter.h
index b752066..ff42db9 100644
--- a/gst/nnstreamer/include/nnstreamer_plugin_api_converter.h
+++ b/gst/nnstreamer/include/nnstreamer_plugin_api_converter.h
@@ -1,5 +1,5 @@
 /**
- * NNStreamer API for Tensor_Decoder Sub-Plugins
+ * NNStreamer API for Tensor_Converter Sub-Plugins
  * Copyright (C) 2019 MyungJoo Ham <myungjoo.ham@samsung.com>
  *
  * This library is free software; you can redistribute it and/or
@@ -42,33 +42,36 @@ typedef struct _NNStreamerExternalConverter
 {
   const char *name;
 
-/** 1. chain func, data handling. */
+  /* 1. chain func, data handling. */
   GstBuffer *(*convert) (GstBuffer * in_buf, gsize * frame_size,
       guint * frames_in, GstTensorsConfig * config);
-/** Convert the given input stream to tensor/tensors stream.
-  * @param[in] buf The input stream buffer
-  * @param[out] frame_size The size of each frame (output buffer)
-  * @param[out] frames_in The number of frames in the given input buffer.
-  * @param[out] config tensors config structure to be filled
-  * @retval Return input buffer(in_buf) if the data is to be kept untouched.
-  * @retval Return a new GstBuf if the data is to be modified.
-  */
+  /**< Convert the given input stream to tensor/tensors stream.
+   *
+   * @param[in] buf The input stream buffer
+   * @param[out] frame_size The size of each frame (output buffer)
+   * @param[out] frames_in The number of frames in the given input buffer.
+   * @param[out] config tensors config structure to be filled
+   * @retval Return input buffer(in_buf) if the data is to be kept untouched.
+   * @retval Return a new GstBuf if the data is to be modified.
+   */
 
-/** 2. get_out_config (type conf, input(media) to output(tensor)) */
+  /* 2. get_out_config (type conf, input(media) to output(tensor)) */
   gboolean (*get_out_config) (const GstCaps * in_caps,
     GstTensorsConfig * config);
-/** Set the tensor config structure from the given stream frame
-  * @param[in] in_caps The input (original/media data) stream's metadata
-  * @param[out] config The output (tensor/tensors) metadata
-  * @retval Return True if get caps successfully, FALSE if not.
-  */
+  /**< Set the tensor config structure from the given stream frame.
+   *
+   * @param[in] in_caps The input (original/media data) stream's metadata
+   * @param[out] config The output (tensor/tensors) metadata
+   * @retval Return True if get caps successfully, FALSE if not.
+   */
 
-/** 3. query_caps (tpye conf, output(tensor) to input(media)) */
+  /* 3. query_caps (type conf, output(tensor) to input(media)) */
   GstCaps *(*query_caps) (const GstTensorsConfig * config);
-/** Filters (narrows down) the GstCap (st) with the given config.
-  * @param[in] config The config of output tensor/tensors
-  * @retval Return subplugin caps (if config is NULL, return default caps)
-  */
+  /**< Filters (narrows down) the GstCap (st) with the given config.
+   *
+   * @param[in] config The config of output tensor/tensors
+   * @retval Return subplugin caps (if config is NULL, return default caps)
+   */
 } NNStreamerExternalConverter;
 
 /**
diff --git a/gst/nnstreamer/include/tensor_typedef.h b/gst/nnstreamer/include/tensor_typedef.h
index 44d55b8..5ad7b32 100644
--- a/gst/nnstreamer/include/tensor_typedef.h
+++ b/gst/nnstreamer/include/tensor_typedef.h
@@ -52,7 +52,7 @@
 #define GST_TENSOR_TYPE_ALL "{ float32, float64, int64, uint64, int32, uint32, int16, uint16, int8, uint8 }"
 
 /**
- * @brief Default static capibility for other/tensor
+ * @brief Default static capability for other/tensor
  */
 #define GST_TENSOR_CAP_DEFAULT \
     "other/tensor, " \
@@ -65,7 +65,7 @@
      */
 
 /**
- * @brief Default static capibility for other/tensors
+ * @brief Default static capability for other/tensors
  */
 #define GST_TENSORS_CAP_DEFAULT \
     "other/tensors, " \
@@ -80,7 +80,7 @@
      */
 
 /**
- * @brief Default static capibility for Protocol Buffers
+ * @brief Default static capability for Protocol Buffers
  * protobuf converter will convert this capability to other/tensor(s)
  * @todo Move this definition to proper header file
  */
@@ -88,7 +88,7 @@
     "other/protobuf-tensor, " \
     "framerate = " GST_TENSOR_RATE_RANGE
 /**
- * @brief Default static capibility for flatbuffers
+ * @brief Default static capability for flatbuffers
  * Flatbuf converter will convert this capability to other/tensor(s)
  * @todo Move this definition to proper header file
  */