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 cf486a4153b2c874602484091cb9833dcd451073..b958e75a1560f529a74ec4289892944cbd425dce 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 f807223b90d5ce50fb3f26d74b91f8484069e163..4f0dd52fa5e00a942cc14609d6a6d42b6352a389 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 aafe9fa66ddcdaf9474fa26bc0a4578ca78822dc..f8dd837f62a27b817b69e320778deeeca5b28485 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 ed19c409a3b8f8542b22c1dc55315d662840b74a..e861255c8cb5ff510520d1f01ea4d90656d129a1 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 caf68b389937c4279a669b11ea9cbd8302e088b7..6e4d51a88a8038c2f82cb9c725f898e4373b0a60 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 268f404d641d9515459cd2d813936e016dda0166..fa03fdcefcbc92d3459e45416e3026a7af6b2759 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 81da4c738bb46f70eaa1149d790548b37122cf11..4d644fa9d29b70da7786aeb903c04b75401a7155 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 3622bbea598b2523b3dadabbb53540823b18b445..f43ac3f9fe6386969280b50fa54dfce882d39fbd 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 fcaffbb812a1df72392eb4c367b74fd1b32711a8..5fee607b0a68be5d2915e66ed738f40f3a5f77a1 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 7a69384ec44c4b70e3c617dc07862a4ff62f203a..22c40a6443bde5a4d2faa136e1467f4b85c191a3 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 d89804abb409dc5e22fb9ede1e194ba392d0332d..d6dc762a0256c6ca27b61d6e0615b350fd99736b 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 e820f2c5b2a9d3cc8a12f9542739d2da2e339696..92f953475cda5b2690e05335d88e4b25d5b3f971 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"