docstrings: port ulinks to markdown links
authorMathieu Duponchelle <mathieu@centricular.com>
Fri, 23 Aug 2019 16:56:01 +0000 (18:56 +0200)
committerMathieu Duponchelle <mathieu@centricular.com>
Fri, 23 Aug 2019 16:56:01 +0000 (18:56 +0200)
18 files changed:
ext/flac/gstflacdec.c
ext/flac/gstflacenc.c
ext/lame/gstlamemp3enc.c
ext/pulse/pulsesink.c
ext/pulse/pulsesrc.c
ext/speex/gstspeexdec.c
ext/speex/gstspeexenc.c
ext/vpx/gstvp8dec.c
ext/vpx/gstvp8enc.c
ext/vpx/gstvp9dec.c
ext/vpx/gstvp9enc.c
ext/wavpack/gstwavpackdec.c
ext/wavpack/gstwavpackenc.c
gst/audiofx/audiofirfilter.c
gst/audiofx/audioiirfilter.c
gst/isomp4/gstqtmux-doc.c
gst/isomp4/gstqtmux.c
gst/shapewipe/gstshapewipe.c

index e0c54f8..468675d 100644 (file)
@@ -25,8 +25,7 @@
  * @see_also: #GstFlacEnc
  *
  * flacdec decodes FLAC streams.
- * <ulink url="http://flac.sourceforge.net/">FLAC</ulink>
- * is a Free Lossless Audio Codec.
+ * [FLAC](http://flac.sourceforge.net/) is a Free Lossless Audio Codec.
  *
  * ## Example launch line
  * |[
index 4bd318f..4f94905 100644 (file)
@@ -22,9 +22,9 @@
  * @see_also: #GstFlacDec
  *
  * flacenc encodes FLAC streams.
- * <ulink url="http://flac.sourceforge.net/">FLAC</ulink>
- * is a Free Lossless Audio Codec. FLAC audio can directly be written into
- * a file, or embedded into containers such as oggmux or matroskamux.
+ * [FLAC](http://flac.sourceforge.net/) is a Free Lossless Audio Codec.
+ * FLAC audio can directly be written into a file, or embedded into containers
+ * such as oggmux or matroskamux.
  *
  * ## Example launch line
  * |[
index 6f6962c..424845e 100644 (file)
  * @see_also: lame, mad, vorbisenc
  *
  * This element encodes raw integer audio into an MPEG-1 layer 3 (MP3) stream.
- * Note that <ulink url="http://en.wikipedia.org/wiki/MP3">MP3</ulink> is not
+ * Note that [MP3](http://en.wikipedia.org/wiki/MP3) is not
  * a free format, there are licensing and patent issues to take into
- * consideration. See <ulink url="http://www.vorbis.com/">Ogg/Vorbis</ulink>
- * for a royalty free (and often higher quality) alternative.
+ * consideration. See [Ogg/Vorbis](http://www.vorbis.com/) for a royalty free
+ * (and often higher quality) alternative.
  *
  * ## Output sample rate
  *
index 7ce9cd8..e0f536b 100644 (file)
@@ -27,7 +27,7 @@
  * @see_also: pulsesrc
  *
  * This element outputs audio to a
- * <ulink href="http://www.pulseaudio.org">PulseAudio sound server</ulink>.
+ * [PulseAudio sound server](http://www.pulseaudio.org).
  *
  * ## Example pipelines
  * |[
@@ -1959,7 +1959,7 @@ gst_pulsesink_class_init (GstPulseSinkClass * klass)
    * GstPulseSink:stream-properties:
    *
    * List of pulseaudio stream properties. A list of defined properties can be
-   * found in the <ulink url="http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html">pulseaudio api docs</ulink>.
+   * found in the [pulseaudio api docs](http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html).
    *
    * Below is an example for registering as a music application to pulseaudio.
    * |[
index 8beb165..ed74771 100644 (file)
@@ -25,7 +25,7 @@
  * @see_also: pulsesink
  *
  * This element captures audio from a
- * <ulink href="http://www.pulseaudio.org">PulseAudio sound server</ulink>.
+ * [PulseAudio sound server](http://www.pulseaudio.org).
  *
  * ## Example pipelines
  * |[
@@ -185,7 +185,7 @@ gst_pulsesrc_class_init (GstPulseSrcClass * klass)
    * GstPulseSrc:stream-properties:
    *
    * List of pulseaudio stream properties. A list of defined properties can be
-   * found in the <ulink href="http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html">pulseaudio api docs</ulink>.
+   * found in the [pulseaudio api docs](http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html).
    *
    * Below is an example for registering as a music application to pulseaudio.
    * |[
index b6106f6..ca2dfdb 100644 (file)
@@ -24,9 +24,8 @@
  * @see_also: speexenc, oggdemux
  *
  * This element decodes a Speex stream to raw integer audio.
- * <ulink url="http://www.speex.org/">Speex</ulink> is a royalty-free
- * audio codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org
- * Foundation</ulink>.
+ * [Speex](http://www.speex.org/) is a royalty-free
+ * audio codec maintained by the [Xiph.org Foundation](http://www.xiph.org/).
  *
  * ## Example pipelines
  * |[
index 5dd205f..52faa6e 100644 (file)
@@ -23,9 +23,8 @@
  * @see_also: speexdec, oggmux
  *
  * This element encodes audio as a Speex stream.
- * <ulink url="http://www.speex.org/">Speex</ulink> is a royalty-free
- * audio codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org
- * Foundation</ulink>.
+ * [Speex](http://www.speex.org/) is a royalty-free
+ * audio codec maintained by the [Xiph.org Foundation](http://www.xiph.org/).
  *
  * ## Example pipelines
  * |[
index fcfca75..8aea6ac 100644 (file)
  * @see_also: vp8enc, matroskademux
  *
  * This element decodes VP8 streams into raw video.
- * <ulink url="http://www.webmproject.org">VP8</ulink> is a royalty-free
- * video codec maintained by <ulink url="http://www.google.com/">Google
- * </ulink>. It's the successor of On2 VP3, which was the base of the
- * Theora video codec.
+ * [VP8](http://www.webmproject.org) is a royalty-free video codec maintained by
+ * [Google](http://www.google.com/). It's the successor of On2 VP3, which was
+ * the base of the Theora video codec.
  *
  * ## Example pipeline
  * |[
index f60f9ac..1e93ada 100644 (file)
  * @see_also: vp8dec, webmmux, oggmux
  *
  * This element encodes raw video into a VP8 stream.
- * <ulink url="http://www.webmproject.org">VP8</ulink> is a royalty-free
- * video codec maintained by <ulink url="http://www.google.com/">Google
- * </ulink>. It's the successor of On2 VP3, which was the base of the
- * Theora video codec.
+ * [VP8](http://www.webmproject.org) is a royalty-free video codec maintained by
+ * [Google](http://www.google.com/). It's the successor of On2 VP3, which was
+ * the base of the Theora video codec.
  *
  * To control the quality of the encoding, the #GstVP8Enc:target-bitrate,
  * #GstVP8Enc:min-quantizer, #GstVP8Enc:max-quantizer or #GstVP8Enc:cq-level
  * properties can be used. Which one is used depends on the mode selected by
  * the #GstVP8Enc:end-usage property.
- * See <ulink url="http://www.webmproject.org/docs/encoder-parameters/">Encoder Parameters</ulink>
+ * See [Encoder Parameters](http://www.webmproject.org/docs/encoder-parameters/)
  * for explanation, examples for useful encoding parameters and more details
  * on the encoding parameters.
  *
index 2cb8fb9..3066f31 100644 (file)
  * @see_also: vp9enc, matroskademux
  *
  * This element decodes VP9 streams into raw video.
- * <ulink url="http://www.webmproject.org">VP9</ulink> is a royalty-free
- * video codec maintained by <ulink url="http://www.google.com/">Google
- * </ulink>. It's the successor of On2 VP3, which was the base of the
- * Theora video codec.
+ * [VP9](http://www.webmproject.org) is a royalty-free video codec maintained by
+ * [Google](http://www.google.com/) It's the successor of On2 VP3, which was the
+ * base of the Theora video codec.
  *
  * ## Example pipeline
  * |[
index 3fd1748..3628564 100644 (file)
  * @see_also: vp9dec, webmmux, oggmux
  *
  * This element encodes raw video into a VP9 stream.
- * <ulink url="http://www.webmproject.org">VP9</ulink> is a royalty-free
- * video codec maintained by <ulink url="http://www.google.com/">Google
- * </ulink>. It's the successor of On2 VP3, which was the base of the
- * Theora video codec.
+ * [VP9](http://www.webmproject.org) is a royalty-free video codec maintained by
+ * [Google](http://www.google.com/). It's the successor of On2 VP3, which was
+ * the base of the Theora video codec.
  *
  * To control the quality of the encoding, the #GstVP9Enc:target-bitrate,
  * #GstVP9Enc:min-quantizer, #GstVP9Enc:max-quantizer or #GstVP9Enc:cq-level
  * properties can be used. Which one is used depends on the mode selected by
  * the #GstVP9Enc:end-usage property.
- * See <ulink url="http://www.webmproject.org/docs/encoder-parameters/">Encoder Parameters</ulink>
+ * See [Encoder Parameters](http://www.webmproject.org/docs/encoder-parameters/)
  * for explanation, examples for useful encoding parameters and more details
  * on the encoding parameters.
  *
index 0d06486..a87774a 100644 (file)
@@ -27,8 +27,8 @@
  *
  * WavpackDec decodes framed (for example by the WavpackParse element)
  * Wavpack streams and decodes them to raw audio.
- * <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source
- * audio codec that features both lossless and lossy encoding.
+ * [Wavpack](http://www.wavpack.com/) is an open-source audio codec that
+ * features both lossless and lossy encoding.
  *
  * ## Example launch line
  * |[
index 95bd8f2..21b6754 100644 (file)
@@ -24,8 +24,8 @@
  * @title: wavpackenc
  *
  * WavpackEnc encodes raw audio into a framed Wavpack stream.
- * <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source
- * audio codec that features both lossless and lossy encoding.
+ * [Wavpack](http://www.wavpack.com/) is an open-source audio codec that
+ * features both lossless and lossy encoding.
  *
  * ## Example launch line
  * |[
index 1e3a2ab..f059685 100644 (file)
@@ -23,8 +23,9 @@
  * SECTION:element-audiofirfilter
  * @title: audiofirfilter
  *
- * audiofirfilter implements a generic audio <ulink url="http://en.wikipedia.org/wiki/Finite_impulse_response">FIR filter</ulink>. Before usage the
- * "kernel" property has to be set to the filter kernel that should be
+ * audiofirfilter implements a generic audio
+ * [FIR filter](http://en.wikipedia.org/wiki/Finite_impulse_response). Before
+ * usage the "kernel" property has to be set to the filter kernel that should be
  * used and the "latency" property has to be set to the latency (in samples)
  * that is introduced by the filter kernel. Setting a latency of n samples
  * will lead to the first n samples being dropped from the output and
index 81b0bbc..867bc9b 100644 (file)
  * SECTION:element-audioiirfilter
  * @title: audioiirfilter
  *
- * audioiirfilter implements a generic audio <ulink url="http://en.wikipedia.org/wiki/Infinite_impulse_response">IIR filter</ulink>. Before usage the
- * "a" and "b" properties have to be set to the filter coefficients that
- * should be used.
+ * audioiirfilter implements a generic audio
+ * [IIR filter](http://en.wikipedia.org/wiki/Infinite_impulse_response).
+ * Before usage the "a" and "b" properties have to be set to the filter
+ * coefficients that should be used.
  *
  * The filter coefficients describe the numerator and denominator of the
  * transfer function.
index be09f19..c290981 100644 (file)
  * The following background intends to explain why various similar muxers
  * are present in this plugin.
  *
- * The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf">
- * QuickTime file format specification</ulink> served as basis for the MP4 file
- * format specification (mp4mux), and as such the QuickTime file structure is
- * nearly identical to the so-called ISO Base Media file format defined in
- * ISO 14496-12 (except for some media specific parts).
+ * The [QuickTime file format specification](http://www.apple.com/quicktime/resources/qtfileformat.pdf)
+ * served as basis for the MP4 file format specification (mp4mux), and as such
+ * the QuickTime file structure is nearly identical to the so-called ISO Base
+ * Media file format defined in ISO 14496-12 (except for some media specific
+ * parts).
+ *
  * In turn, the latter ISO Base Media format was further specialized as a
  * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
  * and in various 3GPP(2) specs (3gppmux).
  * The following background intends to explain why various similar muxers
  * are present in this plugin.
  *
- * The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf">
- * QuickTime file format specification</ulink> served as basis for the MP4 file
- * format specification (mp4mux), and as such the QuickTime file structure is
- * nearly identical to the so-called ISO Base Media file format defined in
- * ISO 14496-12 (except for some media specific parts).
+ * The [QuickTime file format specification](http://www.apple.com/quicktime/resources/qtfileformat.pdf)
+ * served as basis for the MP4 file format specification (mp4mux), and as such
+ * the QuickTime file structure is nearly identical to the so-called ISO Base
+ * Media file format defined in ISO 14496-12 (except for some media specific
+ * parts).
+ *
  * In turn, the latter ISO Base Media format was further specialized as a
  * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
  * and in various 3GPP(2) specs (3gppmux).
  * The following background intends to explain why various similar muxers
  * are present in this plugin.
  *
- * The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf">
- * QuickTime file format specification</ulink> served as basis for the MP4 file
- * format specification (mp4mux), and as such the QuickTime file structure is
- * nearly identical to the so-called ISO Base Media file format defined in
- * ISO 14496-12 (except for some media specific parts).
+ * The [QuickTime file format specification](http://www.apple.com/quicktime/resources/qtfileformat.pdf)
+ * served as basis for the MP4 file format specification (mp4mux), and as such
+ * the QuickTime file structure is nearly identical to the so-called ISO Base
+ * Media file format defined in ISO 14496-12 (except for some media specific
+ * parts).
+ *
  * In turn, the latter ISO Base Media format was further specialized as a
  * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
  * and in various 3GPP(2) specs (3gppmux).
  * The following background intends to explain why various similar muxers
  * are present in this plugin.
  *
- * The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf">
- * QuickTime file format specification</ulink> served as basis for the MP4 file
- * format specification (mp4mux), and as such the QuickTime file structure is
- * nearly identical to the so-called ISO Base Media file format defined in
- * ISO 14496-12 (except for some media specific parts).
+ * The [QuickTime file format specification](http://www.apple.com/quicktime/resources/qtfileformat.pdf)
+ * served as basis for the MP4 file format specification (mp4mux), and as such
+ * the QuickTime file structure is nearly identical to the so-called ISO Base
+ * Media file format defined in ISO 14496-12 (except for some media specific
+ * parts).
+ *
  * In turn, the latter ISO Base Media format was further specialized as a
  * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
  * and in various 3GPP(2) specs (3gppmux).
index 9886d75..4b6182c 100644 (file)
  * The following background intends to explain why various similar muxers
  * are present in this plugin.
  *
- * The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf">
- * QuickTime file format specification</ulink> served as basis for the MP4 file
- * format specification (mp4mux), and as such the QuickTime file structure is
- * nearly identical to the so-called ISO Base Media file format defined in
- * ISO 14496-12 (except for some media specific parts).
+ * The [QuickTime file format specification](http://www.apple.com/quicktime/resources/qtfileformat.pdf)
+ * served as basis for the MP4 file format specification (mp4mux), and as such
+ * the QuickTime file structure is nearly identical to the so-called ISO Base
+ * Media file format defined in ISO 14496-12 (except for some media specific
+ * parts).
+ *
  * In turn, the latter ISO Base Media format was further specialized as a
  * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
  * and in various 3GPP(2) specs (gppmux).
index 35d322e..5ca9559 100644 (file)
@@ -27,8 +27,7 @@
  * can be added by the border property.
  *
  * Transition bitmaps can be downloaded from the
- * <ulink url="http://cinelerra.org/transitions.php">Cinelerra transition</ulink>
- * page.
+ * [Cinelerra transition](http://cinelerra.org/transitions.php) page.
  *
  * ## Example launch line
  * |[