More docs coverage and some ChangeLog surgery (add missing names)
authorStefan Kost <ensonic@users.sourceforge.net>
Thu, 15 Feb 2007 15:17:23 +0000 (15:17 +0000)
committerStefan Kost <ensonic@users.sourceforge.net>
Thu, 15 Feb 2007 15:17:23 +0000 (15:17 +0000)
Original commit message from CVS:
* ext/cdparanoia/gstcdparanoiasrc.h:
* ext/ogg/gstoggdemux.h:
* gst-libs/gst/audio/audio.c: (gst_audio_frame_byte_size),
(gst_audio_frame_length), (gst_audio_duration_from_pad_buffer),
(gst_audio_is_buffer_framed), (gst_audio_structure_set_int):
* gst-libs/gst/audio/audio.h:
* gst-libs/gst/audio/gstaudiofilter.h:
* gst-libs/gst/interfaces/videoorientation.h:
* gst/adder/gstadder.h:
More docs coverage and some ChangeLog surgery (add missing names)

ChangeLog
ext/cdparanoia/gstcdparanoiasrc.h
ext/ogg/gstoggdemux.h
gst-libs/gst/audio/audio.c
gst-libs/gst/audio/audio.h
gst-libs/gst/audio/gstaudiofilter.h
gst-libs/gst/interfaces/videoorientation.h
gst/adder/gstadder.h

index 83f25ce..6f9e443 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2007-02-15  Stefan Kost  <ensonic@users.sf.net>
+
+       * ext/cdparanoia/gstcdparanoiasrc.h:
+       * ext/ogg/gstoggdemux.h:
+       * gst-libs/gst/audio/audio.c: (gst_audio_frame_byte_size),
+       (gst_audio_frame_length), (gst_audio_duration_from_pad_buffer),
+       (gst_audio_is_buffer_framed), (gst_audio_structure_set_int):
+       * gst-libs/gst/audio/audio.h:
+       * gst-libs/gst/audio/gstaudiofilter.h:
+       * gst-libs/gst/interfaces/videoorientation.h:
+       * gst/adder/gstadder.h:
+         More docs coverage and some ChangeLog surgery (add missing names)
+
 2007-02-15  Wim Taymans  <wim@fluendo.com>
 
        * sys/ximage/ximagesink.c:
 
 === release 0.10.0 ===
 
-2005-12-05   <thomas (at) apestaart (dot) org>
+2005-12-05 Thomas Vander Stichele  <thomas (at) apestaart (dot) org>
 
        * configure.ac:
          releasing 0.10.0, "Mont-d'or"
 
 === release 0.9.7 ===
 
-2005-12-01   <thomas (at) apestaart (dot) org>
+2005-12-01  Thomas Vander Stichele  <thomas (at) apestaart (dot) org>
 
        * configure.ac:
          releasing 0.9.7, "Mi Perro No Tiene Ninguna Nariz"
        (gst_videoscale_fixate_caps): Introduce back caps fixate with
        handling of PAR.
 
-2005-11-18    <bilboed@dvdsrc.fluendo.com>
+2005-11-18  Edward Hervey  <bilboed@dvdsrc.fluendo.com>
 
        * gst/playback/gstdecodebin.c: (gst_decode_bin_init): 
        Unsetting IS_SINK flag from the fakesink, so decodebin
        Resync if the buffer timestamps drift more than a 10th 
        of a second.
 
-2005-08-31  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-08-31  Tim-Philipp Müller  <tim at centricular dot net>
 
        * sys/v4l/gstv4lsrc.c: (gst_v4lsrc_set_property),
        (gst_v4lsrc_get_property):
          Added rtp timestamp -> gst timestamp conversion.
          Fixed several problems with queue.
 
-2005-08-09  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-08-09  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst-libs/gst/audio/gstaudioclock.h:
        * gst-libs/gst/audio/gstaudiofilter.h:
          Add padding (you will need to rebuild gst-plugins-base,
          gst-plugins and all applications afterwards!)
 
-2005-08-09  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-08-09  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst-libs/gst/riff/riff-read.c: (gst_riff_read_chunk),
        (gst_riff_parse_chunk):
        New API functions. The device should be opened before acquiring
        and closed after releasing.
 
-2005-08-08  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-08-08  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst-libs/gst/interfaces/mixer.h:
          Reset padding to GST_PADDING.
        * ext/alsa/gstalsasink.c (alsasink_sink_factory): Advertise our
        support of both endiannesses.
 
-2005-07-28  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-07-28  Tim-Philipp Müller  <tim at centricular dot net>
 
        * ext/vorbis/vorbisdec.c: (vorbis_dec_src_query):
          Fix confusing debug message (s/event/query/)
 
-2005-07-28  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-07-28  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/videotestsrc/videotestsrc.h:
          Use "_stdint.h" instead of <stdint.h>
 
 2005-02-22  Luca Ognibene  <luogni@tin.it>
 
-       Reviewed by: Tim-Philipp M??ller  <tim at centricular dot net>
+       Reviewed by: Tim-Philipp Müller  <tim at centricular dot net>
 
        * ext/gdk_pixbuf/pixbufscale.c: (gst_pixbufscale_link):
          Don't leak caps string (fixes #168134)
        (gst_jpegenc_change_state):
          Don't leak line buffers and context struct (fixes #168133).
 
-2005-02-21  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-02-21  Tim-Philipp Müller  <tim at centricular dot net>
 
        * configure.ac:
        * ext/dirac/gstdiracdec.cc:
        * gst/dvdlpcmdec/gstdvdlpcmdec.c: (gst_dvdlpcmdec_chain):
          Make sure we only write to writable buffers
 
-2005-02-20  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-02-20  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst-libs/gst/riff/riff-media.c:
        (gst_riff_create_audio_caps_with_data):
 
 2005-02-19  Martin Holters  <martin.holters@gmx.de>
 
-       Reviewed by: Tim-Philipp M??ller  <tim at centricular dot net>
+       Reviewed by: Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/audioconvert/bufferframesconvert.c:
        (buffer_frames_convert_link):
        (gst_visual_change_state):
          Support libvisual 0.2.0.
 
-2005-02-18  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-02-18  Tim-Philipp Müller  <tim at centricular dot net>
 
        * ext/jpeg/gstjpegdec.c: (gst_jpegdec_chain):
        * ext/jpeg/gstjpegenc.c: (gst_jpegenc_resync), (gst_jpegenc_chain):
          Use same rowstrides for I420 as used everywhere else.
 
-2005-02-17  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-02-17  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/avi/gstavidemux.c: (gst_avi_demux_invert):
          Declare variables at beginning of block and make gcc-2.95 happy
 
 2005-02-17  Luca Ognibene  <luogni at tin dot it>
 
-       Reviewed by: Tim-Philipp M??ller  <tim at centricular dot net>
+       Reviewed by: Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/tcp/gsttcpserversink.c: (gst_tcpserversink_init_send):
          Don't pass uninitialised values to setsockopt(). (fixes #167704)
          events into the stream thread from whichever thread
          sends them.
 
-2005-02-15  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-02-15  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/speed/demo-mp3.c: (time_tick_cb), (main):
          Display current position and track length; misc. clean-ups.
          channel. Previously used different signs made the signals cancel
          each other out and appear like silence. (fixes #167269)
 
-2005-02-12  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-02-12  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/ffmpegcolorspace/avcodec.h:
        * gst/ffmpegcolorspace/gstffmpegcodecmap.c:
        (gst_xvimagesink_buffer_alloc), (gst_xvimagesink_set_xwindow_id),
        (gst_xvimagesink_expose): Check for xcontext before trying to link.
 
-2005-02-12  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-02-12  Tim-Philipp Müller  <tim at centricular dot net>
 
        * ext/dvdnav/dvdnavsrc.c: (dvdnavsrc_open):
          Don't send "Hey! You gave me a NULL pointer you naughty person" as
        * gst/librfb/rfbdecoder.h:
        * gst/librfb/rfbutil.h:
 
-2005-02-10  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-02-10  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/speed/Makefile.am:
        * gst/speed/demo-mp3.c: (main):
          Don't clobber the stack constructing the channels array.
          Make the element chain-based. DTS tracks can now be played.
          
-2005-02-09  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-02-09  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst-libs/gst/audio/multichannel.h:
        * gst-libs/gst/gconf/gconf.h:
        * gst/law/mulaw-encode.c: (mulawenc_link):
          Fix caps memleaks (#166600).
 
-2005-02-08  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-02-08  Tim-Philipp Müller  <tim at centricular dot net>
 
        * ext/tarkin/mem.h:
        * ext/tarkin/wavelet.h:
        * gst/subparse/gstsubparse.c:
          Fix OSX buildbot.
 
-2005-01-31  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-01-31  Tim-Philipp Müller  <tim at centricular dot net>
 
        * ext/theora/theoraenc.c: (theora_buffer_from_packet),
        (theora_enc_chain), (theora_enc_change_state):
          Set granulepos and timestamp correctly for streams not
          starting at 0, taking into account the initial delay.
 
-2005-01-31  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-01-31  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/mpegstream/gstdvddemux.c:
          Add audio/x-dts to audio pad template caps
        * ext/cairo/gsttextoverlay.c: include  string.h and strings.h to fix
        build failure on amd64
 
-2005-01-26  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-01-26  Tim-Philipp Müller  <tim at centricular dot net>
 
        * ext/mad/gstid3tag.c: (mad_id3_parse_latin1_string),
        (mad_id3_parse_comment_frame), (gst_mad_id3_to_tag_list):
          Allow for 0-sized buffers. Fixes length query problems in
          starwars.mkv from the testsuite.
 
-2005-01-19  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-01-19  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/videobox/gstvideobox.c: (gst_video_box_copy_plane_i420),
        (gst_video_box_i420), (gst_video_box_chain):
          Fix off-by-one bug. Fixes warnings during playback of sincity.mp4
          when fixating to six channels in Totem.
 
-2005-01-17  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-01-17  Tim-Philipp Müller  <tim at centricular dot net>
 
        * ext/dvdread/dvdreadsrc.c: (get_next_cell_for):
          Fix compile warnings on Solaris 10 buildbot
 
-2005-01-17  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-01-17  Tim-Philipp Müller  <tim at centricular dot net>
 
        * ext/dvdread/dvdreadsrc.c: (_read):
          Don't read beyond the last cell in a chapter (fixes 
          invalid memory access)
 
-2005-01-17  Tim-Philipp M??ller  <tim at centricular dot net>
+2005-01-17  Tim-Philipp Müller  <tim at centricular dot net>
 
        * ext/dvdread/stream_labels.c:
        (dvdreadsrc_get_audio_stream_labels):
 2005-01-14  Ronald S. Bultje  <rbultje@ronald.bitfreak.net>
 
        * sys/v4l/gstv4lelement.c: (gst_v4l_iface_supported):
-         Revert Johan??s 1.35->1.36 since it breaks compat.
+         Revert Johan's 1.35->1.36 since it breaks compat.
 
 2005-01-14  Stephane LOEUILLET  <stephane.loeuillet@tiscali.fr>
 
 
 2005-01-05  Thomas Vander Stichele  <thomas at apestaart dot org>
 
-       patch by: Tim-Philipp M??ller  <t.i.m@zen.co.uk>
+       patch by: Tim-Philipp Müller  <t.i.m@zen.co.uk>
 
        * gst/playback/gstplaybasebin.c:
         Fix for #162924 - free caps after use, not before
        Fix code to not use GCC extensions (and c99 extensions that
        Forte does not like.)
 
-2004-12-19  Tim-Philipp M??ller  <t.i.m@zen.co.uk>
+2004-12-19  Tim-Philipp Müller  <t.i.m@zen.co.uk>
 
        Reviewed by:  Ronald S. Bultje  <rbultje@ronald.bitfreak.net>
 
 
 2004-11-23  Thomas Vander Stichele  <thomas at apestaart dot org>
 
-       patch by: Tim-Philipp M??ller <t.i.m@zen.co.uk>
+       patch by: Tim-Philipp Müller <t.i.m@zen.co.uk>
 
        * ext/dvdread/dvdreadsrc.c:
          Fixes invalid reads (#158462)
          wouldn't do anything because we're not negotiated yet, leading
          to an infinite loop. Showed in e.g. Rhythmbox. Fixes #158006.
 
-2004-11-11  Tim-Philipp M??ller  <t.i.m@zen.co.uk>
+2004-11-11  Tim-Philipp Müller  <t.i.m@zen.co.uk>
 
        reviewed by:  Ronald S. Bultje  <rbultje@ronald.bitfreak.net>
 
        * ext/mad/gstid3tag.c: (gst_id3_tag_do_typefind):
          Hide unused glory.
 
-2004-11-06  Tim-Philipp M??ller  <t.i.m@zen.co.uk>
+2004-11-06  Tim-Philipp Müller  <t.i.m@zen.co.uk>
 
        reviewed by: Ronald S. Bultje  <rbultje@ronald.bitfreak.net>
 
        * ext/vorbis/vorbisenc.c: (raw_caps_factory):
          Fix weird caps (#157548).
 
-2004-11-06  Tim-Philipp M??ller  <t.i.m@zen.co.uk>
+2004-11-06  Tim-Philipp Müller  <t.i.m@zen.co.uk>
 
        Reviewed by: Ronald S. Bultje  <rbultje@ronald.bitfreak.net>
 
        * sys/v4l/gstv4lsrc.c: (gst_v4lsrc_src_link), (gst_v4lsrc_getcaps):
        Fix for webcams that support only specific width or height
 
-2004-10-09  Tim-Philipp M??ller  <t.i.m@zen.co.uk>
+2004-10-09  Tim-Philipp Müller  <t.i.m@zen.co.uk>
 
        Reviewed by:  Ronald S. Bultje  <rbultje@ronald.bitfreak.net>
 
        * gst/auparse/gstauparse.c: (gst_auparse_chain):
          Error out on invalid data (fixes #154807).
 
-2004-10-09  Tim-Philipp M??ller  <t.i.m@zen.co.uk>
+2004-10-09  Tim-Philipp Müller  <t.i.m@zen.co.uk>
 
        Reviewed by: Ronald S. Bultje  <rbultje@ronald.bitfreak.net>
 
        Add support for the new_media flag when sending DISCONT events
        Make the querying work when video pad is not linked
 
-2004-06-07  Tim-Philipp M??ller  <t.i.m@zen.co.uk>
+2004-06-07  Tim-Philipp Müller  <t.i.m@zen.co.uk>
 
        reviewed by Benjamin Otte  <otte@gnome.org>
 
          bogus timestamps and screwing sync.
        (fixes #143454)
 
-2004-06-07  Tim-Philipp M??ller  <t.i.m@zen.co.uk>
+2004-06-07  Tim-Philipp Müller  <t.i.m@zen.co.uk>
 
        reviewed by Benjamin Otte  <otte@gnome.org>
 
        * sys/oss/.cvsignore:
          add for oss_probe
 
-2004-04-03  Tim-Phillip M??ller <t.i.m@zen.co.uk>
+2004-04-03  Tim-Phillip Müller <t.i.m@zen.co.uk>
 
        reviewed by Benjamin Otte  <otte@gnome.org>
 
 
        * configure.ac: GST_PACKAGE default: s/GStreamer/GStreamer Plugins/
 
-2004-03-20  Tim-Phillip M??ller <t.i.m@zen.co.uk>
+2004-03-20  Tim-Phillip Müller <t.i.m@zen.co.uk>
 
        reviewed by: Benjamin Otte  <otte@gnome.org>
 
 
        * testsuite/gst-lint:  Add a check for bad signal names.
 
-2004-03-04  <kost@imn.htwk-leipzig.de>
+2004-03-04  Stefan Kost <kost@imn.htwk-leipzig.de>
 
        reviewed by David Schleef
 
index 373a742..c9f5ba0 100644 (file)
@@ -45,6 +45,11 @@ G_BEGIN_DECLS
 typedef struct _GstCdParanoiaSrc GstCdParanoiaSrc;
 typedef struct _GstCdParanoiaSrcClass GstCdParanoiaSrcClass;
 
+/**
+ * GstCdParanoiaSrc:
+ *
+ * The cdparanoia object structure.
+ */
 struct _GstCdParanoiaSrc {
   GstCddaBaseSrc   cddabasesrc;
 
index f8f5612..f79fd8d 100644 (file)
@@ -130,6 +130,11 @@ struct _GstOggPadClass
 #define GST_CHAIN_LOCK(ogg)     g_mutex_lock((ogg)->chain_lock)
 #define GST_CHAIN_UNLOCK(ogg)   g_mutex_unlock((ogg)->chain_lock)
 
+/**
+ * GstOggDemux:
+ *
+ * The ogg demuxer object structure.
+ */
 struct _GstOggDemux
 {
   GstElement element;
index c3b6c07..4b68806 100644 (file)
 /**
  * SECTION:gstaudio
  * @short_description: Support library for audio elements
+ *
+ * This library contains some helper functions for audio elements.
  */
 
+/**
+ * gst_audio_frame_byte_size:
+ * @pad: the #GstPad to get the caps from
+ *
+ * Calculate byte size of an audio frame.
+ *
+ * Returns: -1 if there's an error (to avoid division by zero),
+ * or the byte size if everything's ok
+ */
 int
 gst_audio_frame_byte_size (GstPad * pad)
 {
-/* calculate byte size of an audio frame
- * this should be moved closer to the gstreamer core
- * and be implemented for every mime type IMO
- * returns -1 if there's an error (to avoid division by zero),
- * or the byte size if everything's ok
- */
+  /* FIXME: this should be moved closer to the gstreamer core
+   * and be implemented for every mime type IMO
+   */
 
   int width = 0;
   int channels = 0;
@@ -63,14 +71,21 @@ gst_audio_frame_byte_size (GstPad * pad)
   return (width / 8) * channels;
 }
 
+/**
+ * gst_audio_frame_length:
+ * @pad: the #GstPad to get the caps from
+ * @buf: the #GstBuffer
+ *
+ * Calculate length of buffer in frames.
+ *
+ * Returns: 0 if there's an error, or the number of frames if everything's ok
+ */
 long
 gst_audio_frame_length (GstPad * pad, GstBuffer * buf)
-/* calculate length of buffer in frames
- * this should be moved closer to the gstreamer core
- * and be implemented for every mime type IMO
- * returns 0 if there's an error, or the number of frames if everything's ok
- */
 {
+  /* FIXME: this should be moved closer to the gstreamer core
+   * and be implemented for every mime type IMO
+   */
   int frame_byte_size = 0;
 
   frame_byte_size = gst_audio_frame_byte_size (pad);
@@ -83,14 +98,19 @@ gst_audio_frame_length (GstPad * pad, GstBuffer * buf)
   return GST_BUFFER_SIZE (buf) / frame_byte_size;
 }
 
+/**
+ * gst_audio_duration_from_pad_buffer:
+ * @pad: the #GstPad to get the caps from
+ * @buf: the #GstBuffer
+ *
+ * Calculate length in nanoseconds of audio buffer @buf based on capabilities of
+ * @pad.
+ *
+ * Return: the length.
+ */
 GstClockTime
 gst_audio_duration_from_pad_buffer (GstPad * pad, GstBuffer * buf)
 {
-/* calculate length in nanoseconds
- * of audio buffer buf
- * based on capabilities of pad
- */
-
   long bytes = 0;
   int width = 0;
   int channels = 0;
@@ -125,9 +145,17 @@ gst_audio_duration_from_pad_buffer (GstPad * pad, GstBuffer * buf)
   return length;
 }
 
+/**
+ * gst_audio_is_buffer_framed:
+ * @pad: the #GstPad to get the caps from
+ * @buf: the #GstBuffer
+ *
+ * Check if the buffer size is a whole multiple of the frame size.
+ *
+ * Returns: %TRUE if buffer size is multiple.
+ */
 gboolean
 gst_audio_is_buffer_framed (GstPad * pad, GstBuffer * buf)
-/* check if the buffer size is a whole multiple of the frame size */
 {
   if (GST_BUFFER_SIZE (buf) % gst_audio_frame_byte_size (pad) == 0)
     return TRUE;
@@ -191,9 +219,21 @@ _gst_audio_structure_set_list (GstStructure * structure,
   va_end (varargs);
 }
 
+/**
+ * gst_audio_structure_set_int:
+ * @structure: a #GstStructure
+ * @flag: a set of #GstAudioFieldFlag
+ *
+ * Do not use anymore.
+ * @Deprecated: use gst_structure_set()
+ */
 void
 gst_audio_structure_set_int (GstStructure * structure, GstAudioFieldFlag flag)
 {
+  /* was added here:
+   * http://webcvs.freedesktop.org/gstreamer/gst-plugins-base/gst-libs/gst/audio/audio.c?r1=1.16&r2=1.17
+   * but it is not used
+   */
   if (flag & GST_AUDIO_FIELD_RATE)
     gst_structure_set (structure, "rate", GST_TYPE_INT_RANGE, 1, G_MAXINT,
         NULL);
index f2bb770..b5de533 100644 (file)
@@ -50,12 +50,31 @@ G_BEGIN_DECLS
  * Thomas, 6 September 2002 */
 
 /* conversion macros */
+/**
+ * GST_FRAMES_TO_CLOCK_TIME:
+ * @frames: sample frames
+ * @rate: sampling rate
+ * 
+ * Calculate clocktime from sample @frames and @rate.
+ */
 #define GST_FRAMES_TO_CLOCK_TIME(frames, rate) \
   ((GstClockTime) (((gdouble) frames / rate) * GST_SECOND))
 
+/**
+ * GST_CLOCK_TIME_TO_FRAMES:
+ * @clocktime: clock time
+ * @rate: sampling rate
+ * 
+ * Calculate frames from @clocktime and sample @rate.
+ */
 #define GST_CLOCK_TIME_TO_FRAMES(clocktime, rate) \
   ((gint64) ((gst_guint64_to_gdouble (clocktime) / GST_SECOND) * rate))
 
+/**
+ * GST_AUDIO_DEF_RATE:
+ * 
+ * Standard sampling rate used in consumer audio.
+ */
 #define GST_AUDIO_DEF_RATE 44100
 
 #define GST_AUDIO_INT_PAD_TEMPLATE_CAPS \
@@ -67,7 +86,6 @@ G_BEGIN_DECLS
   "depth = (int) [ 1, 32 ], " \
   "signed = (boolean) { true, false }"
 
-
 /* "standard" int audio is native order, 16 bit stereo. */
 #define GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS \
   "audio/x-raw-int, " \
@@ -110,6 +128,12 @@ GstClockTime gst_audio_duration_from_pad_buffer (GstPad * pad, GstBuffer * buf);
 gboolean gst_audio_is_buffer_framed     (GstPad* pad, GstBuffer* buf);
 
 /* functions useful for _getcaps functions */
+/**
+ * GstAudioFieldFlag:
+ *
+ * Do not use anymore.
+ * @Deprecated: use gst_structure_set() directly
+ */
 typedef enum {
   GST_AUDIO_FIELD_RATE          = (1 << 0),
   GST_AUDIO_FIELD_CHANNELS      = (1 << 1),
index c0a6c0c..c6fefe4 100644 (file)
@@ -43,6 +43,7 @@ typedef struct _GstAudioFilterClass GstAudioFilterClass;
 
 /**
  * GstAudioFilter:
+ * @basetransform: Element parent class
  *
  * Base class for audio filters with the same format for input and output.
  *
index 67c0614..1b3b56e 100644 (file)
@@ -36,8 +36,27 @@ G_BEGIN_DECLS
 #define GST_VIDEO_ORIENTATION_GET_IFACE(inst) \
   (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_VIDEO_ORIENTATION, GstVideoOrientationInterface))
 
+/**
+ * GstVideoOrientation:
+ *
+ * Opaque #GstVideoOrientation data structure.
+ */
 typedef struct _GstVideoOrientation GstVideoOrientation;
 
+/**
+ * GstVideoOrientationInterface:
+ * @parent: parent interface type.
+ * @get_hflip: virtual method to get horizontal flipping state
+ * @get_vflip: virtual method to get vertical flipping state
+ * @get_hcenter: virtual method to get horizontal centering state
+ * @get_vcenter: virtual method to get vertical centering state
+ * @set_hflip: virtual method to set horizontal flipping state
+ * @set_vflip: virtual method to set vertical flipping state
+ * @set_hcenter: virtual method to set horizontal centering state
+ * @set_vcenter: virtual method to set vertical centering state
+ *
+ * #GstVideoOrientationInterface interface.
+ */
 typedef struct _GstVideoOrientationInterface {
   GTypeInterface parent;
 
@@ -52,6 +71,7 @@ typedef struct _GstVideoOrientationInterface {
   gboolean (* set_hcenter) (GstVideoOrientation *video_orientation, gint center);
   gboolean (* set_vcenter) (GstVideoOrientation *video_orientation, gint center);
 
+  /*< private > */
   gpointer _gst_reserved[GST_PADDING];
 } GstVideoOrientationInterface;
 
index 2f14d92..62c990a 100644 (file)
@@ -47,6 +47,11 @@ typedef enum {
 
 typedef void (*GstAdderFunction) (gpointer out, gpointer in, guint size);
 
+/**
+ * GstAdder:
+ *
+ * The adder object structure.
+ */
 struct _GstAdder {
   GstElement      element;