doc: remove xml from comments

This commit is contained in:
Mathieu Duponchelle 2019-05-30 01:12:59 +02:00
parent 1d2994ce64
commit d98835fdef
7 changed files with 60 additions and 73 deletions

View File

@ -265,9 +265,9 @@ validate_name (const gchar * name)
* first character, followed by either lowercase ASCII letters, digits or * first character, followed by either lowercase ASCII letters, digits or
* hyphens ('-'). * hyphens ('-').
* *
* The @category <emphasis>should</emphasis> be one of the existing * The @category *should* be one of the existing
* well-defined categories, like #GST_ENCODING_CATEGORY_DEVICE, but it * well-defined categories, like #GST_ENCODING_CATEGORY_DEVICE, but it
* <emphasis>can</emphasis> be a application or user specific category if * *can* be a application or user specific category if
* needed. * needed.
* *
* Returns: (transfer full): The newly created #GstEncodingTarget or %NULL if * Returns: (transfer full): The newly created #GstEncodingTarget or %NULL if

View File

@ -26,46 +26,38 @@
* *
* Waveform specific notes: * Waveform specific notes:
* *
* <orderedlist> * ## Gaussian white noise
* <listitem> *
* <itemizedlist><title>Gaussian white noise</title> * This waveform produces white (zero mean) Gaussian noise.
* Volume sets the standard deviation of the noise in units of the range
* of values of the sample type, e.g. volume=0.1 produces noise with a
* standard deviation of 0.1*32767=3277 with 16-bit integer samples,
* or 0.1*1.0=0.1 with floating-point samples.
* *
* This waveform produces white (zero mean) Gaussian noise. * ## Ticks
* Volume sets the standard deviation of the noise in units of the range
* of values of the sample type, e.g. volume=0.1 produces noise with a
* standard deviation of 0.1*32767=3277 with 16-bit integer samples,
* or 0.1*1.0=0.1 with floating-point samples.
* *
* </itemizedlist> * This waveform is special in that it does not produce one continuous
* </listitem> * signal. Instead, it produces finite-length sine wave pulses (the "ticks").
* <listitem> * It is useful for detecting time shifts between audio signal, for example
* <itemizedlist><title>Ticks</title> * between RTSP audio clients that shall play synchronized. It is also useful
* * for generating a signal that feeds the trigger of an oscilloscope.
* This waveform is special in that it does not produce one continuous
* signal. Instead, it produces finite-length sine wave pulses (the "ticks").
* It is useful for detecting time shifts between audio signal, for example
* between RTSP audio clients that shall play synchronized. It is also useful
* for generating a signal that feeds the trigger of an oscilloscope.
* *
* To further help with oscilloscope triggering and time offset detection, * To further help with oscilloscope triggering and time offset detection,
* the waveform can apply a different volume to every Nth tick (this is then * the waveform can apply a different volume to every Nth tick (this is then
* called the "marker tick"). For instance, one could generate a tick every * called the "marker tick"). For instance, one could generate a tick every
* 100ms, and make every 20th tick a marker tick (meaning that every 2 seconds * 100ms, and make every 20th tick a marker tick (meaning that every 2 seconds
* there is a marker tick). This is useful for detecting large time offsets * there is a marker tick). This is useful for detecting large time offsets
* while still frequently triggering an oscilloscope. * while still frequently triggering an oscilloscope.
* *
* Also, a "ramp" can be applied to the begin & end of ticks. The sudden * Also, a "ramp" can be applied to the begin & end of ticks. The sudden
* start of the sine tick is a discontinuity, even if the sine wave starts * start of the sine tick is a discontinuity, even if the sine wave starts
* at 0. The* resulting artifacts can often make it more difficult to use the * at 0. The* resulting artifacts can often make it more difficult to use the
* ticks for an oscilloscope's trigger. To that end, an initial "ramp" can * ticks for an oscilloscope's trigger. To that end, an initial "ramp" can
* be applied. The first few samples are modulated by a cubic function to * be applied. The first few samples are modulated by a cubic function to
* reduce the impact of the discontinuity, resulting in smaller artifacts. * reduce the impact of the discontinuity, resulting in smaller artifacts.
* The number of samples equals floor(samplerate / sine-wave-frequency). * The number of samples equals floor(samplerate / sine-wave-frequency).
* Example: with a sample rate of 48 kHz and a sine wave frequency of 10 kHz, * Example: with a sample rate of 48 kHz and a sine wave frequency of 10 kHz,
* the first 4 samples are modulated by the cubic function. * the first 4 samples are modulated by the cubic function.
* </itemizedlist>
* </listitem>
* </orderedlist>
* *
* ## Example launch line * ## Example launch line
* |[ * |[

View File

@ -59,8 +59,8 @@
* * does not handle network stream buffering. decodebin3 expects that network stream * * does not handle network stream buffering. decodebin3 expects that network stream
* buffering is handled upstream, before data is passed to it. * buffering is handled upstream, before data is passed to it.
* *
* <emphasis>decodebin3 is still experimental API and a technology preview. * > decodebin3 is still experimental API and a technology preview.
* Its behaviour and exposed API is subject to change.</emphasis> * > Its behaviour and exposed API is subject to change.
* *
*/ */

View File

@ -38,8 +38,8 @@
* produce packetised encoded data with timestamps where possible, * produce packetised encoded data with timestamps where possible,
* or send missing-element messages where not. * or send missing-element messages where not.
* *
* <emphasis>parsebin is still experimental API and a technology preview. * > parsebin is still experimental API and a technology preview.
* Its behaviour and exposed API is subject to change.</emphasis> * > Its behaviour and exposed API is subject to change.
*/ */
/* Implementation notes: /* Implementation notes:

View File

@ -29,8 +29,8 @@
* by supporting publication and selection of available streams via the * by supporting publication and selection of available streams via the
* #GstStreamCollection message and #GST_EVENT_SELECT_STREAMS event API. * #GstStreamCollection message and #GST_EVENT_SELECT_STREAMS event API.
* *
* <emphasis>playbin3 is still experimental API and a technology preview. * > playbin3 is still experimental API and a technology preview.
* Its behaviour and exposed API is subject to change.</emphasis> * > Its behaviour and exposed API is subject to change.
* *
* playbin3 can handle both audio and video files and features * playbin3 can handle both audio and video files and features
* *

View File

@ -30,8 +30,8 @@
* *
* The main configuration is via the #GstURISourceBin:uri property. * The main configuration is via the #GstURISourceBin:uri property.
* *
* <emphasis>urisourcebin is still experimental API and a technology preview. * > urisourcebin is still experimental API and a technology preview.
* Its behaviour and exposed API is subject to change.</emphasis> * > Its behaviour and exposed API is subject to change.
*/ */
/* FIXME 0.11: suppress warnings for deprecated API such as GValueArray /* FIXME 0.11: suppress warnings for deprecated API such as GValueArray

View File

@ -73,33 +73,28 @@
* Use the GST_RAW_BASE_PARSE_CONFIG_MUTEX_LOCK and GST_RAW_BASE_PARSE_CONFIG_MUTEX_UNLOCK * Use the GST_RAW_BASE_PARSE_CONFIG_MUTEX_LOCK and GST_RAW_BASE_PARSE_CONFIG_MUTEX_UNLOCK
* macros to protect configuration modifications. * macros to protect configuration modifications.
* *
* <listitem> * ## Summary of the subclass requirements
* <itemizedlist> *
* <title>Summary of the subclass requirements</title> * * Sink caps and properties configurations must both be
* <listitem><para> * implemented and supported. It must also be ensured that there is a
* Sink caps and properties configurations must both be * "current" configuration.
* implemented and supported. It must also be ensured that there is a *
* "current" configuration. * * Modifications to the configurations must be protected with the
* </para></listitem> * GstRawBaseParse lock. This is typically necessary when the
* Modifications to the configurations must be protected with the * properties configuration is modified by setting new property values.
* GstRawBaseParse lock. This is typically necessary when the * (Note that the lock is held during *all* vfunc calls.)
* properties configuration is modified by setting new property values. *
* (Note that the lock is held during *all* vfunc calls.) * * If the properties configuration is updated (typically by
* <listitem><para> * setting new property values), gst_raw_base_parse_invalidate_src_caps()
* If the properties configuration is updated (typically by * must be called if the properties config is the current one. This is
* setting new property values), gst_raw_base_parse_invalidate_src_caps() * necessary to ensure that GstBaseParse pushes a new caps event downstream
* must be called if the properties config is the current one. This is * which contains caps from the updated configuration.
* necessary to ensure that GstBaseParse pushes a new caps event downstream *
* which contains caps from the updated configuration. * * In case there are bytes in each frame that aren't part of the actual
* </para></listitem> * payload, the get_overhead_size() vfunc must be defined, and the
* <listitem><para> * @get_config_frame_size() vfunc must return a frame size that includes
* In case there are bytes in each frame that aren't part of the actual * the number of non-payload bytes (= the overhead). Otherwise, the
* payload, the get_overhead_size() vfunc must be defined, and the * timestamps will incorrectly include the overhead bytes.
* @get_config_frame_size() vfunc must return a frame size that includes
* the number of non-payload bytes (= the overhead). Otherwise, the
* timestamps will incorrectly include the overhead bytes.
* </para></listitem>
* </listitem>
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H