docs: make gtk-doc happier

This commit is contained in:
Tim-Philipp Müller 2011-12-30 19:24:09 +00:00
parent 536e34cb31
commit d877ef13f5
6 changed files with 14 additions and 13 deletions

View file

@ -56,6 +56,10 @@
<xi:include href="xml/gstmultichannel.xml" /> <xi:include href="xml/gstmultichannel.xml" />
<xi:include href="xml/gstaudioringbuffer.xml" /> <xi:include href="xml/gstaudioringbuffer.xml" />
<xi:include href="xml/gstaudioiec61937.xml" /> <xi:include href="xml/gstaudioiec61937.xml" />
<xi:include href="xml/gststreamvolume.xml" />
<xi:include href="xml/gstmixer.xml" />
<xi:include href="xml/gstmixeroptions.xml" />
<xi:include href="xml/gstmixertrack.xml" />
</chapter> </chapter>
<chapter id="gstreamer-ffft"> <chapter id="gstreamer-ffft">
@ -84,19 +88,10 @@
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags. <filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags.
</para> </para>
<xi:include href="xml/gstcolorbalance.xml" />
<xi:include href="xml/gstcolorbalancechannel.xml" />
<xi:include href="xml/gstmixer.xml" />
<xi:include href="xml/gstmixeroptions.xml" />
<xi:include href="xml/gstmixertrack.xml" />
<xi:include href="xml/gstnavigation.xml" /> <xi:include href="xml/gstnavigation.xml" />
<xi:include href="xml/gstpropertyprobe.xml" />
<xi:include href="xml/gststreamvolume.xml" />
<xi:include href="xml/gsttuner.xml" /> <xi:include href="xml/gsttuner.xml" />
<xi:include href="xml/gsttunerchannel.xml" /> <xi:include href="xml/gsttunerchannel.xml" />
<xi:include href="xml/gsttunernorm.xml" /> <xi:include href="xml/gsttunernorm.xml" />
<xi:include href="xml/gstvideoorientation.xml" />
<xi:include href="xml/gstvideooverlay.xml" />
</chapter> </chapter>
<chapter id="gstreamer-riff"> <chapter id="gstreamer-riff">
@ -198,6 +193,10 @@
<xi:include href="xml/gstvideooverlaycomposition.xml" /> <xi:include href="xml/gstvideooverlaycomposition.xml" />
<xi:include href="xml/gstvideofilter.xml" /> <xi:include href="xml/gstvideofilter.xml" />
<xi:include href="xml/gstvideosink.xml" /> <xi:include href="xml/gstvideosink.xml" />
<xi:include href="xml/gstcolorbalance.xml" />
<xi:include href="xml/gstcolorbalancechannel.xml" />
<xi:include href="xml/gstvideoorientation.xml" />
<xi:include href="xml/gstvideooverlay.xml" />
</chapter> </chapter>
</part> </part>

View file

@ -382,7 +382,6 @@ GstAudioRingBuffer
GstAudioRingBufferClass GstAudioRingBufferClass
GstAudioRingBufferSpec GstAudioRingBufferSpec
GstAudioRingBufferCallback GstAudioRingBufferCallback
GstAudioRingBufferSegState
GstAudioRingBufferState GstAudioRingBufferState
GstAudioRingBufferFormatType GstAudioRingBufferFormatType

View file

@ -499,7 +499,7 @@ gst_audio_decoder_finalize (GObject * object)
* sanity checking of @caps and extracts output data format * sanity checking of @caps and extracts output data format
* *
* Returns: %TRUE on success. * Returns: %TRUE on success.
* */ **/
gboolean gboolean
gst_audio_decoder_set_outcaps (GstAudioDecoder * dec, GstCaps * caps) gst_audio_decoder_set_outcaps (GstAudioDecoder * dec, GstCaps * caps)
{ {

View file

@ -157,7 +157,6 @@ struct _GstAudioRingBufferSpec
* @memory: data in the ringbuffer * @memory: data in the ringbuffer
* @size: size of data in the ringbuffer * @size: size of data in the ringbuffer
* @spec: format and layout of the ringbuffer data * @spec: format and layout of the ringbuffer data
* @segstate: status of each segment in the ringbuffer (unused)
* @samples_per_seg: number of samples in one segment * @samples_per_seg: number of samples in one segment
* @empty_seg: pointer to memory holding one segment of silence samples * @empty_seg: pointer to memory holding one segment of silence samples
* @state: state of the buffer * @state: state of the buffer

View file

@ -454,7 +454,8 @@ gst_encoding_container_profile_class_init (GObjectClass * klass)
* @profile: a #GstEncodingContainerProfile * @profile: a #GstEncodingContainerProfile
* *
* Returns: (element-type GstPbutils.EncodingProfile) (transfer none): * Returns: (element-type GstPbutils.EncodingProfile) (transfer none):
* the list of contained #GstEncodingProfile. */ * the list of contained #GstEncodingProfile.
*/
const GList * const GList *
gst_encoding_container_profile_get_profiles (GstEncodingContainerProfile * gst_encoding_container_profile_get_profiles (GstEncodingContainerProfile *
profile) profile)

View file

@ -54,6 +54,9 @@ struct _GstVideoFilter {
/** /**
* GstVideoFilterClass: * GstVideoFilterClass:
* @parent_class: the parent class structure * @parent_class: the parent class structure
* @set_info: function to be called with the negotiated caps and video infos
* @transform_frame: transform a video frame
* @transform_frame_ip: transform a video frame in place
* *
* The video filter class structure. * The video filter class structure.
*/ */