From c5ad1c72287cc08dbfbd2d0f0b3864562f4fa0c1 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Tue, 12 Aug 2008 06:31:49 +0000 Subject: [PATCH] gst-libs/gst/interfaces/propertyprobe.h: Remove double "interface" from doc-string. Original commit message from CVS: * gst-libs/gst/interfaces/propertyprobe.h: Remove double "interface" from doc-string. * gst-libs/gst/interfaces/xoverlay.h: Document interface. * gst-libs/gst/riff/riff.c: Add basic doc blobs. --- ChangeLog | 11 +++++++++++ gst-libs/gst/interfaces/propertyprobe.h | 2 +- gst-libs/gst/interfaces/xoverlay.h | 14 ++++++++++++++ gst-libs/gst/riff/riff.c | 14 +++++++++++++- 4 files changed, 39 insertions(+), 2 deletions(-) diff --git a/ChangeLog b/ChangeLog index 27f49da44c..06eb815e11 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,14 @@ +2008-08-12 Stefan Kost + + * gst-libs/gst/interfaces/propertyprobe.h: + Remove double "interface" from doc-string. + + * gst-libs/gst/interfaces/xoverlay.h: + Document interface. + + * gst-libs/gst/riff/riff.c: + Add basic doc blobs. + 2008-08-11 Stefan Kost * gst-libs/gst/audio/Makefile.am: diff --git a/gst-libs/gst/interfaces/propertyprobe.h b/gst-libs/gst/interfaces/propertyprobe.h index a1e6a62fea..eb949735c8 100644 --- a/gst-libs/gst/interfaces/propertyprobe.h +++ b/gst-libs/gst/interfaces/propertyprobe.h @@ -52,7 +52,7 @@ typedef struct _GstPropertyProbeInterface GstPropertyProbeInterface; * @probe_property: virtual method to probe a property * @get_values: virtual method to get probe results for a property * - * #GstPropertyProbeInterface interface. + * #GstPropertyProbe interface. */ struct _GstPropertyProbeInterface { GTypeInterface klass; diff --git a/gst-libs/gst/interfaces/xoverlay.h b/gst-libs/gst/interfaces/xoverlay.h index 9301d3a7e0..a5cbcfebcd 100644 --- a/gst-libs/gst/interfaces/xoverlay.h +++ b/gst-libs/gst/interfaces/xoverlay.h @@ -41,8 +41,22 @@ G_BEGIN_DECLS #define GST_X_OVERLAY_GET_CLASS(inst) \ (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_X_OVERLAY, GstXOverlayClass)) +/** + * GstXOverlay: + * + * Opaque #GstXOverlay data structure. + */ typedef struct _GstXOverlay GstXOverlay; +/** + * GstXOverlayClass: + * @klass: parent interface type. + * @set_xwindow_id: virtual method to configure the XWindow id + * @expose: virtual method to handle expose events + * @handle_events: virtual method to handle events + * + * #GstXOverlay interface + */ typedef struct _GstXOverlayClass { GTypeInterface klass; diff --git a/gst-libs/gst/riff/riff.c b/gst-libs/gst/riff/riff.c index 0fc7a28de3..a8e267c6c0 100644 --- a/gst-libs/gst/riff/riff.c +++ b/gst-libs/gst/riff/riff.c @@ -1,7 +1,7 @@ /* GStreamer RIFF I/O * Copyright (C) 2003 Ronald Bultje * - * riff.c: plugin registering + * riff.c: library initialisation * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public @@ -18,6 +18,13 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstriff + * @short_description: Riff fileformat utillity functions. + * + * A collection of functions to handle riff base files, such as avi, wav and + * asf. + */ #ifdef HAVE_CONFIG_H #include "config.h" @@ -27,6 +34,11 @@ GST_DEBUG_CATEGORY (riff_debug); +/** + * gst_riff_init: + * + * Initialize riff library. + */ void gst_riff_init (void) {