doc: remove xml from comments
authorMathieu Duponchelle <mathieu@centricular.com>
Wed, 29 May 2019 21:08:22 +0000 (23:08 +0200)
committerMathieu Duponchelle <mathieu@centricular.com>
Wed, 29 May 2019 21:08:22 +0000 (23:08 +0200)
12 files changed:
gst-libs/gst/vaapi/gstvaapitypes.h
gst/vaapi/gstvaapidecodebin.c
gst/vaapi/gstvaapidecodedoc.c
gst/vaapi/gstvaapiencode_h264.c
gst/vaapi/gstvaapiencode_h264_fei.c
gst/vaapi/gstvaapiencode_h265.c
gst/vaapi/gstvaapiencode_jpeg.c
gst/vaapi/gstvaapiencode_mpeg2.c
gst/vaapi/gstvaapiencode_vp8.c
gst/vaapi/gstvaapiencode_vp9.c
gst/vaapi/gstvaapipostproc.c
gst/vaapi/gstvaapisink.c

index cf486a4..b958e75 100644 (file)
@@ -57,11 +57,10 @@ typedef gsize GstVaapiID;
  *
  * Can be used together with #GST_VAAPI_ID_ARGS to properly output an
  * integer value in a printf()-style text message.
- * <informalexample>
- * <programlisting>
+ *
+ * ``` C
  * printf("id: %" GST_VAAPI_ID_FORMAT "\n", GST_VAAPI_ID_ARGS(id));
- * </programlisting>
- * </informalexample>
+ * ```
  */
 #define GST_VAAPI_ID_FORMAT "p"
 
index f807223..4f0dd52 100644 (file)
  * It offers the functionality of GstVaapiDecoder and the many options
  * of #GstVaapiPostproc.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 filesrc location=~/big_buck_bunny.mov ! qtdemux ! h264parse ! vaapidecodebin ! vaapisink
  * ]|
- * </refsect2>
  */
 
 #include "gstcompat.h"
index aafe9fa..f8dd837 100644 (file)
  * processed by other elements, but the performance would be rather
  * bad.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 filesrc location=~/image.jpeg ! jpegparse ! vaapijpegdec ! imagefreeze ! vaapisink
  * ]|
- * </refsect2>
  */
 
 /**
  * processed by other elements, but the performance would be rather
  * bad.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 filesrc location=~/sample.mpg ! mpegpsdemux ! vaapimpeg2dec ! vaapisink
  * ]|
- * </refsect2>
  */
 
 /**
  * processed by other elements, but the performance would be rather
  * bad.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 filesrc location=~/sample.mpeg4 ! mpeg4videoparse ! vaapimpeg4dec ! vaapisink
  * ]|
- * </refsect2>
  */
 
 /**
  * processed by other elements, but the performance would be rather
  * bad.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 filesrc location=~/sample.h263 ! h263parse ! vaapih263dec ! vaapisink
  * ]|
- * </refsect2>
  */
 
 /**
  * processed by other elements, but the performance would be rather
  * bad.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 filesrc location=~/big_buck_bunny.mov ! qtdemux ! h264parse ! vaapih264dec ! vaapisink
  * ]|
- * </refsect2>
  */
 
 /**
  * processed by other elements, but the performance would be rather
  * bad.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 filesrc location=./sample.bin ! h265parse ! vaapih265dec ! vaapisink
  * ]|
- * </refsect2>
  */
 
 /**
  * processed by other elements, but the performance would be rather
  * bad.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 filesrc location=~/elephants_dream.wmv  ! asfdemux ! vaapivc1dec ! vaapisink
  * ]|
- * </refsect2>
  */
 
 /**
  * processed by other elements, but the performance would be rather
  * bad.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 filesrc location=./sample.webm ! matroskademux ! vaapivp8dec ! vaapisink
  * ]|
- * </refsect2>
  */
 
 /**
  * processed by other elements, but the performance would be rather
  * bad.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
  * |[
  * gst-launch-1.0 filesrc location=./sample.vp9.webm ! ivfparse ! vaapivp9dec ! vaapisink
  * ]|
- * </refsect2>
  */
index ed19c40..e861255 100644 (file)
  * you can set #GstVaapiEncodeH264:tune, if your backend supports it,
  * for low-power mode or high compression.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  *  gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapih264enc ! h264parse ! mp4mux ! filesink location=test.mp4
  * ]|
- * </refsect2>
  */
 
 #include "gstcompat.h"
index caf68b3..6e4d51a 100644 (file)
  *
  * Encodes raw video streams into H.264 bitstreams.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  *  gst-launch-1.0 -ev videotestsrc num-buffers=60 !  vaapih264feienc fei-mode=ENC_PAK ! filesink location=test.264
  * ]|
- * </refsect2>
  */
 
 #include "gstcompat.h"
index 268f404..fa03fdc 100644 (file)
  *
  * Encodes raw video streams into HEVC bitstreams.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  *  gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapih265enc ! h265parse ! matroskamux ! filesink location=test.mkv
  * ]|
- * </refsect2>
  */
 
 #include "gstcompat.h"
index 81da4c7..4d644fa 100644 (file)
  *
  * Encodes raw images into JPEG images.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  *  gst-launch-1.0 -ev videotestsrc num-buffers=1 ! timeoverlay ! vaapijpegenc ! filesink location=test.jpg
  * ]|
- * </refsect2>
  */
 
 #include "gstcompat.h"
index 3622bbe..f43ac3f 100644 (file)
  *
  * Encodes raw video streams into MPEG2 bitstreams.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  *  gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapimpeg2enc ! matroskamux ! filesink location=test.mkv
  * ]|
- * </refsect2>
  */
 
 #include "gstcompat.h"
index fcaffbb..5fee607 100644 (file)
  *
  * Encodes raw video streams into VP8 bitstreams.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  *  gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapivp8enc ! matroskamux ! filesink location=test.mkv
  * ]|
- * </refsect2>
  */
 
 #include "gstcompat.h"
index 7a69384..22c40a6 100644 (file)
  *
  * Encodes raw video streams into VP9 bitstreams.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  *  gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapivp9enc ! matroskamux ! filesink location=test.mkv
  * ]|
- * </refsect2>
  */
 
 #include "gstcompat.h"
index d89804a..d6dc762 100644 (file)
  * vaapipostproc consists in various postprocessing algorithms to be
  * applied to VA surfaces.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 videotestsrc ! vaapipostproc ! video/x-raw width=1920, height=1080 ! vaapisink
  * ]|
- * </refsect2>
  */
 
 #include "gstcompat.h"
index e820f2c..92f9534 100644 (file)
  * display using the Video Acceleration (VA) API. The element will
  * create its own internal window and render into it.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
+ *
  * |[
  * gst-launch-1.0 videotestsrc ! vaapisink
  * ]|
- * </refsect2>
  */
 
 #include "gstcompat.h"