[TensorMux] Documentation of Section header in source code
authorjijoong.moon <jijoong.moon@samsung.com>
Fri, 13 Jul 2018 05:24:55 +0000 (14:24 +0900)
committer함명주/동작제어Lab(SR)/Principal Engineer/삼성전자 <myungjoo.ham@samsung.com>
Fri, 13 Jul 2018 06:43:02 +0000 (15:43 +0900)
Add tensromux refsec in source code

Signed-off-by: jijoong.moon <jijoong.moon@samsung.com>
gst/tensor_mux/gsttensormux.c

index 8e1acad..23024de 100644 (file)
  *
  */
 
+/**
+ * SECTION:element-tensormux
+ *
+ * A Muxer that merge tensor stream to tensors stream for NN frameworks.
+ * The output is always in the format of other/tensors
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -v -m tensormux name=mux ! fakesink
+ * filesrc location=b.png ! pngdec ! videoscale ! imagefreeze ! videoconvert ! video/x-raw,format=RGB,width=100,height=100,framerate=0/1  ! tensor_converter ! mux.sink_0
+ * filesrc location=b.png ! pngdec ! videoscale ! imagefreeze ! videoconvert ! video/x-raw,format=RGB,width=100,height=100,framerate=0/1  ! tensor_converter ! mux.sink_1
+ * filesrc location=b.png ! pngdec ! videoscale ! imagefreeze ! videoconvert ! video/x-raw,format=RGB,width=100,height=100,framerate=0/1  ! tensor_converter ! mux.sink_2
+ * ]|
+ * </refsect2>
+ *
+ */
+
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif