add docs to build

Original commit message from CVS:
* Makefile.am:
* configure.ac:
add docs to build
* common/plugins.xsl:
wrap Description into a refsect2
* docs/Makefile.am:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-good-plugins-docs.sgml:
* docs/plugins/gst-plugins-good-plugins-sections.txt:
* gst/goom/Makefile.am:
* gst/goom/gstgoom.c: (gst_goom_get_type), (gst_goom_base_init),
(gst_goom_class_init), (gst_goom_init), (gst_goom_dispose),
(gst_goom_sink_setcaps), (gst_goom_src_setcaps),
(gst_goom_src_negotiate), (gst_goom_event), (gst_goom_chain),
(gst_goom_change_state):
* gst/goom/gstgoom.h:
GstGOOM -> GstGoom
add an example launch line
* gst/level/gstlevel.h:
* gst/monoscope/gstmonoscope.c:
cleanups

5 files changed, 112 insertions, 71 deletions

diff --git a/gst/goom/Makefile.am b/gst/goom/Makefile.am
index a8418d26..465297f0 100644
--- a/gst/goom/Makefile.am
+++ b/gst/goom/Makefile.am
@@ -1,4 +1,3 @@
-
 plugin_LTLIBRARIES = libgstgoom.la
 
 GOOM_FILTER_FILES = filters.c
@@ -6,11 +5,10 @@ GOOM_FILTER_CFLAGS = -UMMX -UUSE_ASM
 
 libgstgoom_la_SOURCES = gstgoom.c goom_core.c $(GOOM_FILTER_FILES) graphic.c lines.c
 
-noinst_HEADERS = filters.h goom_core.h goom_tools.h graphic.h lines.h 
+noinst_HEADERS = gstgoom.h filters.h goom_core.h goom_tools.h graphic.h lines.h 
 
 libgstgoom_la_CFLAGS = $(GST_CFLAGS) $(GOOM_FILTER_CFLAGS) $(GST_PLUGINS_BASE_CFLAGS)
-libgstgoom_la_LIBADD =
-libgstgoom_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS) $(GST_BASE_LIBS)
+libgstgoom_la_LIBADD = $(GST_BASE_LIBS)
+libgstgoom_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS)
 
 EXTRA_DIST = filters.c
-
diff --git a/gst/goom/gstgoom.c b/gst/goom/gstgoom.c
index d59765ba..d1cb712f 100644
--- a/gst/goom/gstgoom.c
+++ b/gst/goom/gstgoom.c
@@ -17,63 +17,33 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-goom
+ * @see_also: synaesthesia
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch -v sinesrc ! goom ! ffmpegcolorspace ! xvimagesink
+ * </programlisting>
+ * </para>
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include <string.h>
 #include <gst/gst.h>
+#include "gstgoom.h"
 #include <gst/video/video.h>
-#include <gst/base/gstadapter.h>
 #include "goom_core.h"
 
 GST_DEBUG_CATEGORY_STATIC (goom_debug);
 #define GST_CAT_DEFAULT goom_debug
 
-#define GOOM_SAMPLES 512
-
-#define GST_TYPE_GOOM (gst_goom_get_type())
-#define GST_GOOM(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_GOOM,GstGOOM))
-#define GST_GOOM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_GOOM,GstGOOM))
-#define GST_IS_GOOM(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_GOOM))
-#define GST_IS_GOOM_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_GOOM))
-
-typedef struct _GstGOOM GstGOOM;
-typedef struct _GstGOOMClass GstGOOMClass;
-
-struct _GstGOOM
-{
-  GstElement element;
-
-  /* pads */
-  GstPad *sinkpad, *srcpad;
-  GstAdapter *adapter;
-
-  /* input tracking */
-  gint sample_rate;
-
-  gint16 datain[2][GOOM_SAMPLES];
-  /* the timestamp of the next frame */
-  GstClockTime audio_basetime;
-  guint64 samples_consumed;
-
-  /* video state */
-  gdouble fps;
-  gint width;
-  gint height;
-  gint channels;
-
-  gboolean disposed;
-};
-
-struct _GstGOOMClass
-{
-  GstElementClass parent_class;
-};
-
-GType gst_goom_get_type (void);
-
-
 /* elementfactory information */
 static GstElementDetails gst_goom_details = {
   "GOOM: what a GOOM!",
@@ -113,9 +83,9 @@ static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
     );
 
 
-static void gst_goom_class_init (GstGOOMClass * klass);
-static void gst_goom_base_init (GstGOOMClass * klass);
-static void gst_goom_init (GstGOOM * goom);
+static void gst_goom_class_init (GstGoomClass * klass);
+static void gst_goom_base_init (GstGoomClass * klass);
+static void gst_goom_init (GstGoom * goom);
 static void gst_goom_dispose (GObject * object);
 
 static GstElementStateReturn gst_goom_change_state (GstElement * element);
@@ -135,24 +105,24 @@ gst_goom_get_type (void)
 
   if (!type) {
     static const GTypeInfo info = {
-      sizeof (GstGOOMClass),
+      sizeof (GstGoomClass),
       (GBaseInitFunc) gst_goom_base_init,
       NULL,
       (GClassInitFunc) gst_goom_class_init,
       NULL,
       NULL,
-      sizeof (GstGOOM),
+      sizeof (GstGoom),
       0,
       (GInstanceInitFunc) gst_goom_init,
     };
 
-    type = g_type_register_static (GST_TYPE_ELEMENT, "GstGOOM", &info, 0);
+    type = g_type_register_static (GST_TYPE_ELEMENT, "GstGoom", &info, 0);
   }
   return type;
 }
 
 static void
-gst_goom_base_init (GstGOOMClass * klass)
+gst_goom_base_init (GstGoomClass * klass)
 {
   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
 
@@ -164,7 +134,7 @@ gst_goom_base_init (GstGOOMClass * klass)
 }
 
 static void
-gst_goom_class_init (GstGOOMClass * klass)
+gst_goom_class_init (GstGoomClass * klass)
 {
   GObjectClass *gobject_class;
   GstElementClass *gstelement_class;
@@ -182,7 +152,7 @@ gst_goom_class_init (GstGOOMClass * klass)
 }
 
 static void
-gst_goom_init (GstGOOM * goom)
+gst_goom_init (GstGoom * goom)
 {
   /* create the sink and src pads */
   goom->sinkpad =
@@ -216,7 +186,7 @@ gst_goom_init (GstGOOM * goom)
 static void
 gst_goom_dispose (GObject * object)
 {
-  GstGOOM *goom = GST_GOOM (object);
+  GstGoom *goom = GST_GOOM (object);
 
   if (!goom->disposed) {
     goom_close ();
@@ -232,7 +202,7 @@ gst_goom_dispose (GObject * object)
 static gboolean
 gst_goom_sink_setcaps (GstPad * pad, GstCaps * caps)
 {
-  GstGOOM *goom;
+  GstGoom *goom;
   GstStructure *structure;
 
   goom = GST_GOOM (GST_PAD_PARENT (pad));
@@ -248,7 +218,7 @@ gst_goom_sink_setcaps (GstPad * pad, GstCaps * caps)
 static gboolean
 gst_goom_src_setcaps (GstPad * pad, GstCaps * caps)
 {
-  GstGOOM *goom;
+  GstGoom *goom;
   GstStructure *structure;
 
   goom = GST_GOOM (GST_PAD_PARENT (pad));
@@ -265,7 +235,7 @@ gst_goom_src_setcaps (GstPad * pad, GstCaps * caps)
 }
 
 static gboolean
-gst_goom_src_negotiate (GstGOOM * goom)
+gst_goom_src_negotiate (GstGoom * goom)
 {
   GstCaps *othercaps, *target, *intersect;
   GstStructure *structure;
@@ -310,7 +280,7 @@ static gboolean
 gst_goom_event (GstPad * pad, GstEvent * event)
 {
   gboolean res;
-  GstGOOM *goom;
+  GstGoom *goom;
 
   goom = GST_GOOM (GST_PAD_PARENT (pad));
 
@@ -336,7 +306,7 @@ gst_goom_event (GstPad * pad, GstEvent * event)
 static GstFlowReturn
 gst_goom_chain (GstPad * pad, GstBuffer * bufin)
 {
-  GstGOOM *goom;
+  GstGoom *goom;
   guint32 bytesperread;
   gint16 *data;
   gint samples_per_frame;
@@ -426,14 +396,14 @@ gst_goom_chain (GstPad * pad, GstBuffer * bufin)
 not_negotiated:
   {
     GST_ELEMENT_ERROR (goom, CORE, NEGOTIATION, (NULL),
-        ("Format wasn't negotiated before chain function"));
+        ("Format wasn't negotiated before chain function."));
     gst_buffer_unref (bufin);
     return GST_FLOW_NOT_NEGOTIATED;
   }
 no_format:
   {
     GST_ELEMENT_ERROR (goom, CORE, NEGOTIATION, (NULL),
-        ("Could not negotiate format"));
+        ("Could not negotiate format on source pad."));
     gst_buffer_unref (bufin);
     return GST_FLOW_ERROR;
   }
@@ -442,7 +412,7 @@ no_format:
 static GstElementStateReturn
 gst_goom_change_state (GstElement * element)
 {
-  GstGOOM *goom = GST_GOOM (element);
+  GstGoom *goom = GST_GOOM (element);
   gint transition;
   GstElementStateReturn ret;
 
diff --git a/gst/goom/gstgoom.h b/gst/goom/gstgoom.h
new file mode 100644
index 00000000..ca5f5ce7
--- /dev/null
+++ b/gst/goom/gstgoom.h
@@ -0,0 +1,74 @@
+/* gstgoom.c: implementation of goom drawing element
+ * Copyright (C) <2001> Richard Boulton <richard@tartarus.org>
+ *
+ * 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_GOOM_H__
+#define __GST_GOOM_H__
+
+G_BEGIN_DECLS
+
+#include <gst/gst.h>
+#include <gst/base/gstadapter.h>
+
+#define GOOM_SAMPLES 512
+
+#define GST_TYPE_GOOM (gst_goom_get_type())
+#define GST_GOOM(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_GOOM,GstGoom))
+#define GST_GOOM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_GOOM,GstGoom))
+#define GST_IS_GOOM(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_GOOM))
+#define GST_IS_GOOM_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_GOOM))
+
+typedef struct _GstGoom GstGoom;
+typedef struct _GstGoomClass GstGoomClass;
+
+struct _GstGoom
+{
+  GstElement element;
+
+  /* pads */
+  GstPad *sinkpad, *srcpad;
+  GstAdapter *adapter;
+
+  /* input tracking */
+  gint sample_rate;
+
+  gint16 datain[2][GOOM_SAMPLES];
+  /* the timestamp of the next frame */
+  GstClockTime audio_basetime;
+  guint64 samples_consumed;
+
+  /* video state */
+  gdouble fps;
+  gint width;
+  gint height;
+  gint channels;
+
+  gboolean disposed;
+};
+
+struct _GstGoomClass
+{
+  GstElementClass parent_class;
+};
+
+GType gst_goom_get_type (void);
+
+G_END_DECLS
+
+#endif /* __GST_GOOM_H__ */
+
diff --git a/gst/level/gstlevel.h b/gst/level/gstlevel.h
index 40862c0b..5a9a1042 100644
--- a/gst/level/gstlevel.h
+++ b/gst/level/gstlevel.h
@@ -77,8 +77,7 @@ struct _GstLevelClass {
   GstBaseTransformClass parent_class;
 };
 
-
-GType gst_level_get_type(void);
+GType gst_level_get_type (void);
 
 
 G_END_DECLS
diff --git a/gst/monoscope/gstmonoscope.c b/gst/monoscope/gstmonoscope.c
index 581560ca..f3916d48 100644
--- a/gst/monoscope/gstmonoscope.c
+++ b/gst/monoscope/gstmonoscope.c
@@ -300,4 +300,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     "monoscope",
     "Monoscope visualization",
-    plugin_init, VERSION, "LGPL", GST_PACKAGE, GST_ORIGIN)
+    plugin_init, VERSION, "LGPL", GST_PACKAGE, GST_ORIGIN);