more section docs

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gsterror.c:
* gst/gstghostpad.c:
* gst/gstobject.h:
* gst/gstxml.c:
more section docs

diff --git a/ChangeLog b/ChangeLog
index 7d1007b..d5b3f2e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2005-11-14  Stefan Kost  <ensonic@users.sf.net>
+
+       * docs/gst/gstreamer-sections.txt:
+       * gst/gsterror.c:
+       * gst/gstghostpad.c:
+       * gst/gstobject.h:
+       * gst/gstxml.c:
+         more section docs
+
 2005-11-14  Wim Taymans  <wim@fluendo.com>
 
        * common/gst.supp:

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 968dbfb..90f4664 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -707,9 +707,9 @@ gst_format_get_type
 <TITLE>GstGhostPad</TITLE>
 GstGhostPad
 gst_ghost_pad_new
+gst_ghost_pad_new_notarget
 gst_ghost_pad_set_target
 gst_ghost_pad_get_target
-gst_ghost_pad_new_notarget
 <SUBSECTION Standard>
 GstGhostPadClass
 GST_GHOST_PAD

diff --git a/gst/gsterror.c b/gst/gsterror.c
index a8fc908..0f649ff 100644 (file)
--- a/gst/gsterror.c
+++ b/gst/gsterror.c
@@ -21,6 +21,9 @@
  * SECTION:gsterror
  * @short_description: Categorized error messages
  *
+ * This module manages localizable error messages. Developers can use
+ * gst_error_get_message() to get a localized message from a error-code and
+ * -domain.
  */
 
 #ifdef HAVE_CONFIG_H

diff --git a/gst/gstghostpad.c b/gst/gstghostpad.c
index 4c9b18b..075f2fe 100644 (file)
--- a/gst/gstghostpad.c
+++ b/gst/gstghostpad.c
@@ -746,7 +746,7 @@ gst_ghost_pad_dispose (GObject * object)
  *
  * Create a new ghostpad without a target with the given direction.
  * A target can be set on the ghostpad later with the
- * #gst_ghost_pad_set_target() function.
+ * gst_ghost_pad_set_target() function.
  *
  * The created ghostpad will not have a padtemplate.
  *
@@ -819,7 +819,7 @@ gst_ghost_pad_get_target (GstGhostPad * gpad)
  * @newtarget: the new pad target
  *
  * Set the new target of the ghostpad @gpad. Any existing target
- * is unlinked.
+ * is unlinked and links to the new target are established.
  *
  * Returns: TRUE if the new target could be set, FALSE otherwise.
  */

diff --git a/gst/gstobject.h b/gst/gstobject.h
index 7d2de8b..efb5878 100644 (file)
--- a/gst/gstobject.h
+++ b/gst/gstobject.h
@@ -242,7 +242,13 @@ struct _GstObject {
  */
 #define GST_CLASS_UNLOCK(obj)           (g_static_rec_mutex_unlock(GST_CLASS_GET_LOCK(obj)))
 
-/* signal_object is used to signal to the whole class */
+/*
+ * GstObjectClass:
+ *
+ * @signal_object: is used to signal to the whole class
+ * @save_thyself: xml serialisation
+ * @restore_thyself: xml de-serialisation
+ */
 struct _GstObjectClass {
   GObjectClass parent_class;
 
@@ -257,7 +263,8 @@ struct _GstObjectClass {
   void         (*object_saved)         (GstObject *object, xmlNodePtr parent);
   void                 (*deep_notify)          (GstObject *object, GstObject *orig, GParamSpec *pspec);
 
-  /* vtable */
+  /*< public >*/
+  /* virtual methods for subclasses */
   xmlNodePtr   (*save_thyself)         (GstObject *object, xmlNodePtr parent);
   void         (*restore_thyself)      (GstObject *object, xmlNodePtr self);
 

diff --git a/gst/gstxml.c b/gst/gstxml.c
index d73b332..afba2dc 100644 (file)
--- a/gst/gstxml.c
+++ b/gst/gstxml.c
@@ -24,6 +24,14 @@
  * SECTION:gstxml
  * @short_description: XML save/restore operations of pipelines
  *
+ * GStreamer pipelines can be saved to xml files using gst_xml_write_file().
+ * They can be loaded back using gst_xml_parse_doc() / gst_xml_parse_file() / 
+ * gst_xml_parse_memory().
+ * Additionally one can load saved pipelines into the gst-editor to inspect the
+ * graph.
+ *
+ * #GstElement implementations need to override gst_object_save_thyself() and
+ * gst_object_restore_thyself().
  */
 
 #include "gst_private.h"