From: Mark Nauwelaerts Date: Wed, 9 Mar 2011 11:18:56 +0000 (+0100) Subject: baseaudioencoder: gtk-doc syntax fixes X-Git-Tag: 1.19.3~511^2~6555^2~587 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=3d2f496b3ae2ca1518a704d3faee7280e920fd05;p=platform%2Fupstream%2Fgstreamer.git baseaudioencoder: gtk-doc syntax fixes --- diff --git a/gst-libs/gst/audio/gstbaseaudioencoder.c b/gst-libs/gst/audio/gstbaseaudioencoder.c index 24f151c..37b3916 100644 --- a/gst-libs/gst/audio/gstbaseaudioencoder.c +++ b/gst-libs/gst/audio/gstbaseaudioencoder.c @@ -100,20 +100,18 @@ * * In particular, base class will either favor tracking upstream timestamps * (at the possible expense of jitter) or aim to arrange for a perfect stream of - * output timestamps, depending on - * perfect-ts. + * output timestamps, depending on #GstBaseAudioEncoder:perfect-ts. * However, in the latter case, the input may not be so perfect or ideal, which * is handled as follows. An input timestamp is compared with the expected * timestamp as dictated by input sample stream and if the deviation is less - * than tolerance, - * the deviation is discarded. Otherwise, it is considered - * a discontuinity and subsequent output timestamp is resynced to the - * new position after performing configured discontinuity processing. - * In the non-perfect-ts case, an upstream variation exceeding tolerance - * only leads to marking DISCONT on subsequent outgoing (while timestamps - * are adjusted to upstream regardless of variation). + * than #GstBaseAudioEncoder:tolerance, the deviation is discarded. + * Otherwise, it is considered a discontuinity and subsequent output timestamp + * is resynced to the new position after performing configured discontinuity + * processing. In the non-perfect-ts case, an upstream variation exceeding + * tolerance only leads to marking DISCONT on subsequent outgoing + * (while timestamps are adjusted to upstream regardless of variation). * While DISCONT is also marked in the perfect-ts case, this one optionally - * (see hard-resync) + * (see #GstBaseAudioEncoder:hard-resync) * performs some additional steps, such as clipping of (early) input samples * or draining all currently remaining input data, depending on the direction * of the discontuinity. @@ -428,7 +426,8 @@ gst_base_audio_encoder_finalize (GObject * object) G_OBJECT_CLASS (parent_class)->finalize (object); } -/** gst_base_audio_encoder_finish_frame: +/** + * gst_base_audio_encoder_finish_frame: * @enc: a #GstBaseAudioEncoder * @buffer: encoded data * @samples: number of samples (per channel) represented by encoded data @@ -1013,7 +1012,8 @@ refuse_caps: } -/** gst_base_audio_encoder_proxy_getcaps: +/** + * gst_base_audio_encoder_proxy_getcaps: * @enc: a #GstBaseAudioEncoder * @caps: initial * @@ -1593,7 +1593,8 @@ gst_base_audio_encoder_sink_activate_push (GstPad * pad, gboolean active) return result; } -/** gst_base_audio_encoder_add_streamheader: +/** + * gst_base_audio_encoder_add_streamheader: * @caps: a #GstCaps * @buf: header buffers *