From d98835fdeff36235aabc6f3fb831301905fc640a Mon Sep 17 00:00:00 2001 From: Mathieu Duponchelle Date: Thu, 30 May 2019 01:12:59 +0200 Subject: [PATCH] doc: remove xml from comments --- gst-libs/gst/pbutils/encoding-target.c | 4 +-- gst/audiotestsrc/gstaudiotestsrc.c | 64 +++++++++++++++------------------- gst/playback/gstdecodebin3.c | 4 +-- gst/playback/gstparsebin.c | 4 +-- gst/playback/gstplaybin3.c | 4 +-- gst/playback/gsturisourcebin.c | 4 +-- gst/rawparse/gstrawbaseparse.c | 49 ++++++++++++-------------- 7 files changed, 60 insertions(+), 73 deletions(-) diff --git a/gst-libs/gst/pbutils/encoding-target.c b/gst-libs/gst/pbutils/encoding-target.c index eed4f8d..4699bec 100644 --- a/gst-libs/gst/pbutils/encoding-target.c +++ b/gst-libs/gst/pbutils/encoding-target.c @@ -265,9 +265,9 @@ validate_name (const gchar * name) * first character, followed by either lowercase ASCII letters, digits or * hyphens ('-'). * - * The @category should be one of the existing + * The @category *should* be one of the existing * well-defined categories, like #GST_ENCODING_CATEGORY_DEVICE, but it - * can be a application or user specific category if + * *can* be a application or user specific category if * needed. * * Returns: (transfer full): The newly created #GstEncodingTarget or %NULL if diff --git a/gst/audiotestsrc/gstaudiotestsrc.c b/gst/audiotestsrc/gstaudiotestsrc.c index f447196..cfdbb71 100644 --- a/gst/audiotestsrc/gstaudiotestsrc.c +++ b/gst/audiotestsrc/gstaudiotestsrc.c @@ -26,46 +26,38 @@ * * Waveform specific notes: * - * - * - * Gaussian white noise + * ## Gaussian white noise + * + * 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. - * 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. + * ## Ticks * - * - * - * - * Ticks - * - * 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. + * 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, - * 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 - * 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 - * while still frequently triggering an oscilloscope. + * To further help with oscilloscope triggering and time offset detection, + * 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 + * 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 + * while still frequently triggering an oscilloscope. * - * 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 - * 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 - * be applied. The first few samples are modulated by a cubic function to - * reduce the impact of the discontinuity, resulting in smaller artifacts. - * 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, - * the first 4 samples are modulated by the cubic function. - * - * - * + * 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 + * 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 + * be applied. The first few samples are modulated by a cubic function to + * reduce the impact of the discontinuity, resulting in smaller artifacts. + * 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, + * the first 4 samples are modulated by the cubic function. * * ## Example launch line * |[ diff --git a/gst/playback/gstdecodebin3.c b/gst/playback/gstdecodebin3.c index 157e32a..fcd730b 100644 --- a/gst/playback/gstdecodebin3.c +++ b/gst/playback/gstdecodebin3.c @@ -59,8 +59,8 @@ * * does not handle network stream buffering. decodebin3 expects that network stream * buffering is handled upstream, before data is passed to it. * - * decodebin3 is still experimental API and a technology preview. - * Its behaviour and exposed API is subject to change. + * > decodebin3 is still experimental API and a technology preview. + * > Its behaviour and exposed API is subject to change. * */ diff --git a/gst/playback/gstparsebin.c b/gst/playback/gstparsebin.c index 621dd91..8194224 100644 --- a/gst/playback/gstparsebin.c +++ b/gst/playback/gstparsebin.c @@ -38,8 +38,8 @@ * produce packetised encoded data with timestamps where possible, * or send missing-element messages where not. * - * parsebin is still experimental API and a technology preview. - * Its behaviour and exposed API is subject to change. + * > parsebin is still experimental API and a technology preview. + * > Its behaviour and exposed API is subject to change. */ /* Implementation notes: diff --git a/gst/playback/gstplaybin3.c b/gst/playback/gstplaybin3.c index 795a141..8889977 100644 --- a/gst/playback/gstplaybin3.c +++ b/gst/playback/gstplaybin3.c @@ -29,8 +29,8 @@ * by supporting publication and selection of available streams via the * #GstStreamCollection message and #GST_EVENT_SELECT_STREAMS event API. * - * playbin3 is still experimental API and a technology preview. - * Its behaviour and exposed API is subject to change. + * > playbin3 is still experimental API and a technology preview. + * > Its behaviour and exposed API is subject to change. * * playbin3 can handle both audio and video files and features * diff --git a/gst/playback/gsturisourcebin.c b/gst/playback/gsturisourcebin.c index 73a86c4..8aed417 100644 --- a/gst/playback/gsturisourcebin.c +++ b/gst/playback/gsturisourcebin.c @@ -30,8 +30,8 @@ * * The main configuration is via the #GstURISourceBin:uri property. * - * urisourcebin is still experimental API and a technology preview. - * Its behaviour and exposed API is subject to change. + * > urisourcebin is still experimental API and a technology preview. + * > Its behaviour and exposed API is subject to change. */ /* FIXME 0.11: suppress warnings for deprecated API such as GValueArray diff --git a/gst/rawparse/gstrawbaseparse.c b/gst/rawparse/gstrawbaseparse.c index 933e59f..f26e3e3 100644 --- a/gst/rawparse/gstrawbaseparse.c +++ b/gst/rawparse/gstrawbaseparse.c @@ -73,33 +73,28 @@ * Use the GST_RAW_BASE_PARSE_CONFIG_MUTEX_LOCK and GST_RAW_BASE_PARSE_CONFIG_MUTEX_UNLOCK * macros to protect configuration modifications. * - * - * - * Summary of the subclass requirements - * - * Sink caps and properties configurations must both be - * implemented and supported. It must also be ensured that there is a - * "current" configuration. - * - * Modifications to the configurations must be protected with the - * GstRawBaseParse lock. This is typically necessary when the - * 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 - * setting new property values), gst_raw_base_parse_invalidate_src_caps() - * must be called if the properties config is the current one. This is - * 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 - * payload, the get_overhead_size() vfunc must be defined, and the - * @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. - * - * + * ## Summary of the subclass requirements + * + * * Sink caps and properties configurations must both be + * implemented and supported. It must also be ensured that there is a + * "current" configuration. + * + * * Modifications to the configurations must be protected with the + * GstRawBaseParse lock. This is typically necessary when the + * 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 + * setting new property values), gst_raw_base_parse_invalidate_src_caps() + * must be called if the properties config is the current one. This is + * 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 + * payload, the get_overhead_size() vfunc must be defined, and the + * @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. */ #ifdef HAVE_CONFIG_H -- 2.7.4