docs/: Correct fixxrefs options.

Original commit message from CVS:
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
Correct fixxrefs options.
* docs/plugins/Makefile.am:
* docs/plugins/gstreamer-plugins-docs.sgml:
* docs/plugins/gstreamer-plugins-sections.txt:
* plugins/elements/Makefile.am:
* plugins/elements/gstcapsfilter.c (gst_capsfilter_details):
* plugins/elements/gstcapsfilter.h (__GST_CAPSFILTER_H__,
GST_TYPE_CAPSFILTER, GST_CAPSFILTER, GST_CAPSFILTER_CLASS,
GST_IS_CAPSFILTER, GST_IS_CAPSFILTER_CLASS, GstCapsFilter,
GstCapsFilterClass, _GstCapsFilter, trans, filter_caps,
_GstCapsFilterClass, trans_class):
* plugins/elements/gstelements.c (name, rank, type, _elements):
* plugins/elements/gstidentity.c
(gst_identity_check_imperfect_timestamp,
gst_identity_check_imperfect_offset):
Document capsfilter and add doc-blurb to identity.

ChangeLog

@@ -1,3 +1,25 @@
+2007-05-06  Stefan Kost  <ensonic@users.sf.net>
+
+	* docs/gst/Makefile.am:
+	* docs/libs/Makefile.am:
+	  Correct fixxrefs options.
+
+	* docs/plugins/Makefile.am:
+	* docs/plugins/gstreamer-plugins-docs.sgml:
+	* docs/plugins/gstreamer-plugins-sections.txt:
+	* plugins/elements/Makefile.am:
+	* plugins/elements/gstcapsfilter.c (gst_capsfilter_details):
+	* plugins/elements/gstcapsfilter.h (__GST_CAPSFILTER_H__,
+	  GST_TYPE_CAPSFILTER, GST_CAPSFILTER, GST_CAPSFILTER_CLASS,
+	  GST_IS_CAPSFILTER, GST_IS_CAPSFILTER_CLASS, GstCapsFilter,
+	  GstCapsFilterClass, _GstCapsFilter, trans, filter_caps,
+	  _GstCapsFilterClass, trans_class):
+	* plugins/elements/gstelements.c (name, rank, type, _elements):
+	* plugins/elements/gstidentity.c
+	  (gst_identity_check_imperfect_timestamp,
+	  gst_identity_check_imperfect_offset):
+	  Document capsfilter and add doc-blurb to identity.
+
 2007-05-04  Tim-Philipp Müller  <tim at centricular dot net>
 
 	* libs/gst/controller/gstcontroller.c:

docs/gst/Makefile.am

@@ -42,7 +42,7 @@ SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
 MKDB_OPTIONS=--sgml-mode --ignore-files=parse
 
 # Extra options to supply to gtkdoc-fixref.
-FIXXREF_OPTIONS=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
+FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
 	--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib
 
 # The files containing the source code. Relative to $(top_srcdir).

docs/libs/Makefile.am

@@ -51,7 +51,7 @@ SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
 MKDB_OPTIONS= --output-format=xml --sgml-mode --ignore-files=trio
 
 # Extra options to supply to gtkdoc-fixref.
-FIXXREF_OPTIONS=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
+FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
 	--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
 	--extra-dir=$(datadir)/gtk-doc/html/gstreamer-@GST_MAJORMINOR@
 

docs/plugins/Makefile.am

@@ -76,6 +76,7 @@ IGNORE_CFILES =
 # the registry won't have the element
 
 EXTRA_HFILES = \
+	$(top_srcdir)/plugins/elements/gstcapsfilter.h \
 	$(top_srcdir)/plugins/elements/gstfakesrc.h \
 	$(top_srcdir)/plugins/elements/gstfakesink.h \
 	$(top_srcdir)/plugins/elements/gstfdsrc.h \

docs/plugins/gstreamer-plugins-docs.sgml

@@ -12,6 +12,7 @@
 
   <chapter>
     <title>gstreamer Elements</title>
+    <xi:include href="xml/element-capsfilter.xml" />
     <xi:include href="xml/element-fakesrc.xml" />
     <xi:include href="xml/element-fakesink.xml" />
     <xi:include href="xml/element-fdsrc.xml" />

docs/plugins/gstreamer-plugins-sections.txt

@@ -81,6 +81,21 @@ GST_IS_FILE_SINK_CLASS
 gst_file_sink_get_type
 </SECTION>
 
+<SECTION>
+<FILE>element-capsfilter</FILE>
+<TITLE>capsfilter</TITLE>
+GstCapsFilter
+<SUBSECTION Standard>
+GstCapsFilterClass
+GST_CAPSFILTER
+GST_IS_CAPSFILTER
+GST_TYPE_CAPSFILTER
+GST_CAPSFILTER_CLASS
+GST_IS_CAPSFILTER_CLASS
+<SUBSECTION Private>
+gst_capsfilter_get_type
+</SECTION>
+
 <SECTION>
 <FILE>element-identity</FILE>
 <TITLE>identity</TITLE>

plugins/elements/Makefile.am

@@ -39,6 +39,7 @@ libgstcoreelements_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS)
 
 noinst_HEADERS =		\
 	gstbufferstore.h	\
+    gstcapsfilter.h		\
 	gstfakesink.h		\
 	gstfakesrc.h		\
 	gstfdsrc.h		\

plugins/elements/gstcapsfilter.c

@@ -19,15 +19,20 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+/**
+ * SECTION:element-capsfilter
+ * @short_description: pass data though unmodified, but enforces format limmits
+ *
+ * The element does not modify data as such, but can enforce limmitations on the
+ * data format.
+ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include "../../gst/gst-i18n-lib.h"
-#include <gst/gst.h>
+#include "gstcapsfilter.h"
-#include <gst/base/gstbasetransform.h>
-
 
 static const GstElementDetails gst_capsfilter_details =
 GST_ELEMENT_DETAILS ("CapsFilter",
@@ -35,36 +40,6 @@ GST_ELEMENT_DETAILS ("CapsFilter",
     "Pass data without modification, limiting formats",
     "David Schleef <ds@schleef.org>");
 
-
-#define GST_TYPE_CAPSFILTER \
-  (gst_capsfilter_get_type())
-#define GST_CAPSFILTER(obj) \
-  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_CAPSFILTER,GstCapsFilter))
-#define GST_CAPSFILTER_CLASS(klass) \
-  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_CAPSFILTER,GstCapsFilterClass))
-#define GST_IS_CAPSFILTER(obj) \
-  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_CAPSFILTER))
-#define GST_IS_CAPSFILTER_CLASS(klass) \
-  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_CAPSFILTER))
-
-typedef struct _GstCapsFilter GstCapsFilter;
-typedef struct _GstCapsFilterClass GstCapsFilterClass;
-
-struct _GstCapsFilter
-{
-  GstBaseTransform trans;
-
-  GstCaps *filter_caps;
-};
-
-struct _GstCapsFilterClass
-{
-  GstBaseTransformClass trans_class;
-};
-
-GType gst_capsfilter_get_type (void);
-
-
 enum
 {
   PROP_0,

plugins/elements/gstcapsfilter.h

@@ -0,0 +1,64 @@
+/* GStreamer
+ * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
+ *                    2000 Wim Taymans <wtay@chello.be>
+ *
+ * gstidentity.h:
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+
+#ifndef __GST_CAPSFILTER_H__
+#define __GST_CAPSFILTER_H__
+
+
+#include <gst/gst.h>
+#include <gst/base/gstbasetransform.h>
+
+G_BEGIN_DECLS
+
+#define GST_TYPE_CAPSFILTER \
+  (gst_capsfilter_get_type())
+#define GST_CAPSFILTER(obj) \
+  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_CAPSFILTER,GstCapsFilter))
+#define GST_CAPSFILTER_CLASS(klass) \
+  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_CAPSFILTER,GstCapsFilterClass))
+#define GST_IS_CAPSFILTER(obj) \
+  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_CAPSFILTER))
+#define GST_IS_CAPSFILTER_CLASS(klass) \
+  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_CAPSFILTER))
+
+typedef struct _GstCapsFilter GstCapsFilter;
+typedef struct _GstCapsFilterClass GstCapsFilterClass;
+
+struct _GstCapsFilter
+{
+  GstBaseTransform trans;
+
+  GstCaps *filter_caps;
+};
+
+struct _GstCapsFilterClass
+{
+  GstBaseTransformClass trans_class;
+};
+
+GType gst_capsfilter_get_type (void);
+
+G_END_DECLS
+
+#endif /* __GST_CAPSFILTER_H__ */
+

plugins/elements/gstelements.c

@@ -27,6 +27,7 @@
 
 #include <gst/gst.h>
 
+#include "gstcapsfilter.h"
 #include "gstfakesink.h"
 #include "gstfakesrc.h"
 #include "gstfdsrc.h"
@@ -41,15 +42,12 @@
 
 struct _elements_entry
 {
-  gchar *name;
+  const gchar *name;
   guint rank;
     GType (*type) (void);
 };
 
 
-/* this declaration is here because there's no gstcapsfilter.h */
-extern GType gst_capsfilter_get_type (void);
-
 static struct _elements_entry _elements[] = {
   {"capsfilter", GST_RANK_NONE, gst_capsfilter_get_type},
   {"fakesrc", GST_RANK_NONE, gst_fake_src_get_type},

plugins/elements/gstidentity.c

@@ -20,7 +20,13 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-
+/**
+ * SECTION:element-identity
+ * @short_description: pass data through without modification
+ *
+ * Dummy element that passes incomming data through unmodified. I has some
+ * useful diagnostic functions, such as offset and timestamp checking.
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"