[Filter/Custom] Remove unnecessary comment

After refactoring the filter-framework callbacks, the size in function
parameter was removed since GstTensorMemory object internally contains
its size. However, its function header comment still remains. This patch
removes that unnecessary comment. Moreover, this updates the comment of
input parameter & return values.

Change-Id: I3d5b77dce8e34509d7e084829db0487951144c45
Signed-off-by: Sangjung Woo <sangjung.woo@samsung.com>

diff --git a/include/tensor_filter_custom.h b/include/tensor_filter_custom.h
index d23f4f6..e9083f0 100644 (file)
--- a/include/tensor_filter_custom.h
+++ b/include/tensor_filter_custom.h
@@ -57,6 +57,7 @@ typedef void (*NNS_custom_exit_func) (void *private_data,
  * @param[in] private_data The pointer returned by NNStreamer_custom_init.
  * @param[in] prop GstTensorFilter's property values. Do not change its values.
  * @param[out] info Structure for tensor info.
+ * @return 0 if success
  */
 typedef int (*NNS_custom_get_input_dimension) (void *private_data,
     const GstTensorFilterProperties * prop, GstTensorsInfo * info);
@@ -66,6 +67,7 @@ typedef int (*NNS_custom_get_input_dimension) (void *private_data,
  * @param[in] private_data The pointer returned by NNStreamer_custom_init.
  * @param[in] prop GstTensorFilter's property values. Do not change its values.
  * @param[out] info Structure for tensor info.
+ * @return 0 if success
  */
 typedef int (*NNS_custom_get_output_dimension) (void *private_data,
     const GstTensorFilterProperties * prop, GstTensorsInfo * info);
@@ -99,10 +101,9 @@ typedef int (*NNS_custom_invoke) (void *private_data,
  * @brief Invoke the "main function". Without allocating output buffer. (fill in the given output buffer)
  * @param[in] private_data The pointer returned by NNStreamer_custom_init.
  * @param[in] prop GstTensorFilter's property values. Do not change its values.
- * @param[in] input pointer to input tensor, size = dim1 x dim2 x dim3 x dim4 x typesize, allocated by caller
+ * @param[in] input The array of input tensors, each tensor size = dim1 x dim2 x dim3 x dim4 x typesize, allocated by caller
  * @param[out] output The array of output tensors, each tensor size = dim1 x dim2 x dim3 x dim4 x typesize, the memory block for output tensor should be allocated. (data in GstTensorMemory)
- * @param[out] size The allocated size.
- * @return The output buffer allocated in the invoke function
+ * @return 0 if success
  */
 typedef int (*NNS_custom_allocate_invoke) (void *private_data,
     const GstTensorFilterProperties * prop, const GstTensorMemory * input, GstTensorMemory * output);