docstrings: port ulinks to markdown links

This commit is contained in:
Mathieu Duponchelle 2019-08-23 18:56:01 +02:00
parent 0dc9e5bff8
commit 3429ddde38
18 changed files with 71 additions and 72 deletions

View file

@ -25,8 +25,7 @@
* @see_also: #GstFlacEnc * @see_also: #GstFlacEnc
* *
* flacdec decodes FLAC streams. * flacdec decodes FLAC streams.
* <ulink url="http://flac.sourceforge.net/">FLAC</ulink> * [FLAC](http://flac.sourceforge.net/) is a Free Lossless Audio Codec.
* is a Free Lossless Audio Codec.
* *
* ## Example launch line * ## Example launch line
* |[ * |[

View file

@ -22,9 +22,9 @@
* @see_also: #GstFlacDec * @see_also: #GstFlacDec
* *
* flacenc encodes FLAC streams. * flacenc encodes FLAC streams.
* <ulink url="http://flac.sourceforge.net/">FLAC</ulink> * [FLAC](http://flac.sourceforge.net/) is a Free Lossless Audio Codec.
* is a Free Lossless Audio Codec. FLAC audio can directly be written into * FLAC audio can directly be written into a file, or embedded into containers
* a file, or embedded into containers such as oggmux or matroskamux. * such as oggmux or matroskamux.
* *
* ## Example launch line * ## Example launch line
* |[ * |[

View file

@ -25,10 +25,10 @@
* @see_also: lame, mad, vorbisenc * @see_also: lame, mad, vorbisenc
* *
* This element encodes raw integer audio into an MPEG-1 layer 3 (MP3) stream. * 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 * a free format, there are licensing and patent issues to take into
* consideration. See <ulink url="http://www.vorbis.com/">Ogg/Vorbis</ulink> * consideration. See [Ogg/Vorbis](http://www.vorbis.com/) for a royalty free
* for a royalty free (and often higher quality) alternative. * (and often higher quality) alternative.
* *
* ## Output sample rate * ## Output sample rate
* *

View file

@ -27,7 +27,7 @@
* @see_also: pulsesrc * @see_also: pulsesrc
* *
* This element outputs audio to a * 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 * ## Example pipelines
* |[ * |[
@ -1959,7 +1959,7 @@ gst_pulsesink_class_init (GstPulseSinkClass * klass)
* GstPulseSink:stream-properties: * GstPulseSink:stream-properties:
* *
* List of pulseaudio stream properties. A list of defined properties can be * 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. * Below is an example for registering as a music application to pulseaudio.
* |[ * |[

View file

@ -25,7 +25,7 @@
* @see_also: pulsesink * @see_also: pulsesink
* *
* This element captures audio from a * 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 * ## Example pipelines
* |[ * |[
@ -185,7 +185,7 @@ gst_pulsesrc_class_init (GstPulseSrcClass * klass)
* GstPulseSrc:stream-properties: * GstPulseSrc:stream-properties:
* *
* List of pulseaudio stream properties. A list of defined properties can be * 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. * Below is an example for registering as a music application to pulseaudio.
* |[ * |[

View file

@ -24,9 +24,8 @@
* @see_also: speexenc, oggdemux * @see_also: speexenc, oggdemux
* *
* This element decodes a Speex stream to raw integer audio. * This element decodes a Speex stream to raw integer audio.
* <ulink url="http://www.speex.org/">Speex</ulink> is a royalty-free * [Speex](http://www.speex.org/) is a royalty-free
* audio codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org * audio codec maintained by the [Xiph.org Foundation](http://www.xiph.org/).
* Foundation</ulink>.
* *
* ## Example pipelines * ## Example pipelines
* |[ * |[

View file

@ -23,9 +23,8 @@
* @see_also: speexdec, oggmux * @see_also: speexdec, oggmux
* *
* This element encodes audio as a Speex stream. * This element encodes audio as a Speex stream.
* <ulink url="http://www.speex.org/">Speex</ulink> is a royalty-free * [Speex](http://www.speex.org/) is a royalty-free
* audio codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org * audio codec maintained by the [Xiph.org Foundation](http://www.xiph.org/).
* Foundation</ulink>.
* *
* ## Example pipelines * ## Example pipelines
* |[ * |[

View file

@ -25,10 +25,9 @@
* @see_also: vp8enc, matroskademux * @see_also: vp8enc, matroskademux
* *
* This element decodes VP8 streams into raw video. * This element decodes VP8 streams into raw video.
* <ulink url="http://www.webmproject.org">VP8</ulink> is a royalty-free * [VP8](http://www.webmproject.org) is a royalty-free video codec maintained by
* video codec maintained by <ulink url="http://www.google.com/">Google * [Google](http://www.google.com/). It's the successor of On2 VP3, which was
* </ulink>. It's the successor of On2 VP3, which was the base of the * the base of the Theora video codec.
* Theora video codec.
* *
* ## Example pipeline * ## Example pipeline
* |[ * |[

View file

@ -25,16 +25,15 @@
* @see_also: vp8dec, webmmux, oggmux * @see_also: vp8dec, webmmux, oggmux
* *
* This element encodes raw video into a VP8 stream. * This element encodes raw video into a VP8 stream.
* <ulink url="http://www.webmproject.org">VP8</ulink> is a royalty-free * [VP8](http://www.webmproject.org) is a royalty-free video codec maintained by
* video codec maintained by <ulink url="http://www.google.com/">Google * [Google](http://www.google.com/). It's the successor of On2 VP3, which was
* </ulink>. It's the successor of On2 VP3, which was the base of the * the base of the Theora video codec.
* Theora video codec.
* *
* To control the quality of the encoding, the #GstVP8Enc:target-bitrate, * To control the quality of the encoding, the #GstVP8Enc:target-bitrate,
* #GstVP8Enc:min-quantizer, #GstVP8Enc:max-quantizer or #GstVP8Enc:cq-level * #GstVP8Enc:min-quantizer, #GstVP8Enc:max-quantizer or #GstVP8Enc:cq-level
* properties can be used. Which one is used depends on the mode selected by * properties can be used. Which one is used depends on the mode selected by
* the #GstVP8Enc:end-usage property. * 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 * for explanation, examples for useful encoding parameters and more details
* on the encoding parameters. * on the encoding parameters.
* *

View file

@ -25,10 +25,9 @@
* @see_also: vp9enc, matroskademux * @see_also: vp9enc, matroskademux
* *
* This element decodes VP9 streams into raw video. * This element decodes VP9 streams into raw video.
* <ulink url="http://www.webmproject.org">VP9</ulink> is a royalty-free * [VP9](http://www.webmproject.org) is a royalty-free video codec maintained by
* video codec maintained by <ulink url="http://www.google.com/">Google * [Google](http://www.google.com/) It's the successor of On2 VP3, which was the
* </ulink>. It's the successor of On2 VP3, which was the base of the * base of the Theora video codec.
* Theora video codec.
* *
* ## Example pipeline * ## Example pipeline
* |[ * |[

View file

@ -25,16 +25,15 @@
* @see_also: vp9dec, webmmux, oggmux * @see_also: vp9dec, webmmux, oggmux
* *
* This element encodes raw video into a VP9 stream. * This element encodes raw video into a VP9 stream.
* <ulink url="http://www.webmproject.org">VP9</ulink> is a royalty-free * [VP9](http://www.webmproject.org) is a royalty-free video codec maintained by
* video codec maintained by <ulink url="http://www.google.com/">Google * [Google](http://www.google.com/). It's the successor of On2 VP3, which was
* </ulink>. It's the successor of On2 VP3, which was the base of the * the base of the Theora video codec.
* Theora video codec.
* *
* To control the quality of the encoding, the #GstVP9Enc:target-bitrate, * To control the quality of the encoding, the #GstVP9Enc:target-bitrate,
* #GstVP9Enc:min-quantizer, #GstVP9Enc:max-quantizer or #GstVP9Enc:cq-level * #GstVP9Enc:min-quantizer, #GstVP9Enc:max-quantizer or #GstVP9Enc:cq-level
* properties can be used. Which one is used depends on the mode selected by * properties can be used. Which one is used depends on the mode selected by
* the #GstVP9Enc:end-usage property. * 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 * for explanation, examples for useful encoding parameters and more details
* on the encoding parameters. * on the encoding parameters.
* *

View file

@ -27,8 +27,8 @@
* *
* WavpackDec decodes framed (for example by the WavpackParse element) * WavpackDec decodes framed (for example by the WavpackParse element)
* Wavpack streams and decodes them to raw audio. * Wavpack streams and decodes them to raw audio.
* <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source * [Wavpack](http://www.wavpack.com/) is an open-source audio codec that
* audio codec that features both lossless and lossy encoding. * features both lossless and lossy encoding.
* *
* ## Example launch line * ## Example launch line
* |[ * |[

View file

@ -24,8 +24,8 @@
* @title: wavpackenc * @title: wavpackenc
* *
* WavpackEnc encodes raw audio into a framed Wavpack stream. * WavpackEnc encodes raw audio into a framed Wavpack stream.
* <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source * [Wavpack](http://www.wavpack.com/) is an open-source audio codec that
* audio codec that features both lossless and lossy encoding. * features both lossless and lossy encoding.
* *
* ## Example launch line * ## Example launch line
* |[ * |[

View file

@ -23,8 +23,9 @@
* SECTION:element-audiofirfilter * SECTION:element-audiofirfilter
* @title: audiofirfilter * @title: audiofirfilter
* *
* audiofirfilter implements a generic audio <ulink url="http://en.wikipedia.org/wiki/Finite_impulse_response">FIR filter</ulink>. Before usage the * audiofirfilter implements a generic audio
* "kernel" property has to be set to the filter kernel that should be * [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) * 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 * 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 * will lead to the first n samples being dropped from the output and

View file

@ -23,9 +23,10 @@
* SECTION:element-audioiirfilter * SECTION:element-audioiirfilter
* @title: audioiirfilter * @title: audioiirfilter
* *
* audioiirfilter implements a generic audio <ulink url="http://en.wikipedia.org/wiki/Infinite_impulse_response">IIR filter</ulink>. Before usage the * audioiirfilter implements a generic audio
* "a" and "b" properties have to be set to the filter coefficients that * [IIR filter](http://en.wikipedia.org/wiki/Infinite_impulse_response).
* should be used. * 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 * The filter coefficients describe the numerator and denominator of the
* transfer function. * transfer function.

View file

@ -55,11 +55,12 @@
* The following background intends to explain why various similar muxers * The following background intends to explain why various similar muxers
* are present in this plugin. * are present in this plugin.
* *
* The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf"> * The [QuickTime file format specification](http://www.apple.com/quicktime/resources/qtfileformat.pdf)
* QuickTime file format specification</ulink> served as basis for the MP4 file * served as basis for the MP4 file format specification (mp4mux), and as such
* format specification (mp4mux), and as such the QuickTime file structure is * the QuickTime file structure is nearly identical to the so-called ISO Base
* nearly identical to the so-called ISO Base Media file format defined in * Media file format defined in ISO 14496-12 (except for some media specific
* ISO 14496-12 (except for some media specific parts). * parts).
*
* In turn, the latter ISO Base Media format was further specialized as a * In turn, the latter ISO Base Media format was further specialized as a
* Motion JPEG-2000 file format in ISO 15444-3 (mj2mux) * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
* and in various 3GPP(2) specs (3gppmux). * and in various 3GPP(2) specs (3gppmux).
@ -103,11 +104,12 @@
* The following background intends to explain why various similar muxers * The following background intends to explain why various similar muxers
* are present in this plugin. * are present in this plugin.
* *
* The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf"> * The [QuickTime file format specification](http://www.apple.com/quicktime/resources/qtfileformat.pdf)
* QuickTime file format specification</ulink> served as basis for the MP4 file * served as basis for the MP4 file format specification (mp4mux), and as such
* format specification (mp4mux), and as such the QuickTime file structure is * the QuickTime file structure is nearly identical to the so-called ISO Base
* nearly identical to the so-called ISO Base Media file format defined in * Media file format defined in ISO 14496-12 (except for some media specific
* ISO 14496-12 (except for some media specific parts). * parts).
*
* In turn, the latter ISO Base Media format was further specialized as a * In turn, the latter ISO Base Media format was further specialized as a
* Motion JPEG-2000 file format in ISO 15444-3 (mj2mux) * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
* and in various 3GPP(2) specs (3gppmux). * and in various 3GPP(2) specs (3gppmux).
@ -152,11 +154,12 @@
* The following background intends to explain why various similar muxers * The following background intends to explain why various similar muxers
* are present in this plugin. * are present in this plugin.
* *
* The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf"> * The [QuickTime file format specification](http://www.apple.com/quicktime/resources/qtfileformat.pdf)
* QuickTime file format specification</ulink> served as basis for the MP4 file * served as basis for the MP4 file format specification (mp4mux), and as such
* format specification (mp4mux), and as such the QuickTime file structure is * the QuickTime file structure is nearly identical to the so-called ISO Base
* nearly identical to the so-called ISO Base Media file format defined in * Media file format defined in ISO 14496-12 (except for some media specific
* ISO 14496-12 (except for some media specific parts). * parts).
*
* In turn, the latter ISO Base Media format was further specialized as a * In turn, the latter ISO Base Media format was further specialized as a
* Motion JPEG-2000 file format in ISO 15444-3 (mj2mux) * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
* and in various 3GPP(2) specs (3gppmux). * and in various 3GPP(2) specs (3gppmux).
@ -201,11 +204,12 @@
* The following background intends to explain why various similar muxers * The following background intends to explain why various similar muxers
* are present in this plugin. * are present in this plugin.
* *
* The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf"> * The [QuickTime file format specification](http://www.apple.com/quicktime/resources/qtfileformat.pdf)
* QuickTime file format specification</ulink> served as basis for the MP4 file * served as basis for the MP4 file format specification (mp4mux), and as such
* format specification (mp4mux), and as such the QuickTime file structure is * the QuickTime file structure is nearly identical to the so-called ISO Base
* nearly identical to the so-called ISO Base Media file format defined in * Media file format defined in ISO 14496-12 (except for some media specific
* ISO 14496-12 (except for some media specific parts). * parts).
*
* In turn, the latter ISO Base Media format was further specialized as a * In turn, the latter ISO Base Media format was further specialized as a
* Motion JPEG-2000 file format in ISO 15444-3 (mj2mux) * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
* and in various 3GPP(2) specs (3gppmux). * and in various 3GPP(2) specs (3gppmux).

View file

@ -55,11 +55,12 @@
* The following background intends to explain why various similar muxers * The following background intends to explain why various similar muxers
* are present in this plugin. * are present in this plugin.
* *
* The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf"> * The [QuickTime file format specification](http://www.apple.com/quicktime/resources/qtfileformat.pdf)
* QuickTime file format specification</ulink> served as basis for the MP4 file * served as basis for the MP4 file format specification (mp4mux), and as such
* format specification (mp4mux), and as such the QuickTime file structure is * the QuickTime file structure is nearly identical to the so-called ISO Base
* nearly identical to the so-called ISO Base Media file format defined in * Media file format defined in ISO 14496-12 (except for some media specific
* ISO 14496-12 (except for some media specific parts). * parts).
*
* In turn, the latter ISO Base Media format was further specialized as a * In turn, the latter ISO Base Media format was further specialized as a
* Motion JPEG-2000 file format in ISO 15444-3 (mj2mux) * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
* and in various 3GPP(2) specs (gppmux). * and in various 3GPP(2) specs (gppmux).

View file

@ -27,8 +27,7 @@
* can be added by the border property. * can be added by the border property.
* *
* Transition bitmaps can be downloaded from the * Transition bitmaps can be downloaded from the
* <ulink url="http://cinelerra.org/transitions.php">Cinelerra transition</ulink> * [Cinelerra transition](http://cinelerra.org/transitions.php) page.
* page.
* *
* ## Example launch line * ## Example launch line
* |[ * |[