From e37568c19606eff5dad61dc4209dfe4c1f0a6967 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 31 Oct 2007 12:47:41 +0000 Subject: [PATCH] tell gtk-doc about the deprecation guard. Apply more doc fixes. Original commit message from CVS: * docs/libs/Makefile.am: * gst-libs/gst/audio/audio.c: * gst-libs/gst/audio/audio.h: * gst-libs/gst/interfaces/mixer.c: tell gtk-doc about the deprecation guard. Apply more doc fixes. --- ChangeLog | 8 ++++++++ docs/libs/Makefile.am | 2 +- gst-libs/gst/audio/audio.c | 5 ++++- gst-libs/gst/audio/audio.h | 5 ++++- gst-libs/gst/interfaces/mixer.c | 4 ---- 5 files changed, 17 insertions(+), 7 deletions(-) diff --git a/ChangeLog b/ChangeLog index 37943b4720..29e07124e6 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2007-10-31 Stefan Kost + + * docs/libs/Makefile.am: + * gst-libs/gst/audio/audio.c: + * gst-libs/gst/audio/audio.h: + * gst-libs/gst/interfaces/mixer.c: + tell gtk-doc about the deprecation guard. Apply more doc fixes. + 2007-10-31 Tim-Philipp Müller * tests/check/libs/audio.c: (init_value_to_channel_layout), diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am index 310b693626..8478a88082 100644 --- a/docs/libs/Makefile.am +++ b/docs/libs/Makefile.am @@ -43,7 +43,7 @@ DOC_SOURCE_DIR=$(top_srcdir)/gst-libs/gst DOC_BUILD_DIR=$(top_builddir)/gst-libs/gst # Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS= +SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" # FIXME : # there's something wrong with gstreamer-sections.txt not being in the dist diff --git a/gst-libs/gst/audio/audio.c b/gst-libs/gst/audio/audio.c index e627642ef0..1a67329eab 100644 --- a/gst-libs/gst/audio/audio.c +++ b/gst-libs/gst/audio/audio.c @@ -224,8 +224,10 @@ _gst_audio_structure_set_list (GstStructure * structure, * @flag: a set of #GstAudioFieldFlag * * Do not use anymore. - * @Deprecated: use gst_structure_set() + * + * Deprecated: use gst_structure_set() */ +#ifndef GST_REMOVE_DEPRECATED void gst_audio_structure_set_int (GstStructure * structure, GstAudioFieldFlag flag) { @@ -251,6 +253,7 @@ gst_audio_structure_set_int (GstStructure * structure, GstAudioFieldFlag flag) _gst_audio_structure_set_list (structure, "signed", G_TYPE_BOOLEAN, 2, TRUE, FALSE, NULL); } +#endif /* GST_REMOVE_DEPRECATED */ /** * gst_audio_buffer_clip: diff --git a/gst-libs/gst/audio/audio.h b/gst-libs/gst/audio/audio.h index e764ae1341..4db99dad04 100644 --- a/gst-libs/gst/audio/audio.h +++ b/gst-libs/gst/audio/audio.h @@ -132,8 +132,10 @@ gboolean gst_audio_is_buffer_framed (GstPad* pad, GstBuffer* buf); * GstAudioFieldFlag: * * Do not use anymore. - * @Deprecated: use gst_structure_set() directly + * + * Deprecated: use gst_structure_set() directly */ +#ifndef GST_DISABLE_DEPRECATED typedef enum { GST_AUDIO_FIELD_RATE = (1 << 0), GST_AUDIO_FIELD_CHANNELS = (1 << 1), @@ -142,6 +144,7 @@ typedef enum { GST_AUDIO_FIELD_DEPTH = (1 << 4), GST_AUDIO_FIELD_SIGNED = (1 << 5), } GstAudioFieldFlag; +#endif /* GST_DISABLE_DEPRECATED */ #ifndef GST_DISABLE_DEPRECATED void gst_audio_structure_set_int (GstStructure *structure, GstAudioFieldFlag flag); diff --git a/gst-libs/gst/interfaces/mixer.c b/gst-libs/gst/interfaces/mixer.c index 246b04e2c8..49ef7d9da6 100644 --- a/gst-libs/gst/interfaces/mixer.c +++ b/gst-libs/gst/interfaces/mixer.c @@ -345,7 +345,6 @@ gst_mixer_get_mixer_flags (GstMixer * mixer) /** * gst_mixer_mute_toggled: - * * @mixer: the #GstMixer (a #GstElement) that owns the track * @track: the GstMixerTrack that has change mute state. * @mute: the new state of the mute flag on the track @@ -379,7 +378,6 @@ gst_mixer_mute_toggled (GstMixer * mixer, GstMixerTrack * track, gboolean mute) /** * gst_mixer_record_toggled: - * * @mixer: the #GstMixer (a #GstElement) that owns the track * @track: the GstMixerTrack that has changed recording state. * @record: the new state of the record flag on the track @@ -415,7 +413,6 @@ gst_mixer_record_toggled (GstMixer * mixer, /** * gst_mixer_volume_changed: - * * @mixer: the #GstMixer (a #GstElement) that owns the track * @track: the GstMixerTrack that has changed. * @volumes: Array of volume values, one per channel on the mixer track. @@ -467,7 +464,6 @@ gst_mixer_volume_changed (GstMixer * mixer, /** * gst_mixer_option_changed: - * * @mixer: the #GstMixer (a #GstElement) that owns the options * @opts: the GstMixerOptions that has changed value. * @value: the new value of the GstMixerOptions.