Document preset-iface vmethods.

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstpreset.h:
Document preset-iface vmethods.

diff --git a/ChangeLog b/ChangeLog
index c0b4841..82f8036 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
 2008-08-11  Stefan Kost  <ensonic@users.sf.net>
 
+       * docs/gst/gstreamer-sections.txt:
+       * gst/gstpreset.h:
+         Document preset-iface vmethods.
+
+2008-08-11  Stefan Kost  <ensonic@users.sf.net>
+
        * docs/manual/advanced-interfaces.xml:
          Turn thoughts about HAL into a note-tag. Remove mentioning that is
          only used to discover devices.

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index cb209ae..97b74a6 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -1690,6 +1690,7 @@ gst_poll_wait
 <FILE>gstpreset</FILE>
 <TITLE>GstPreset</TITLE>
 GstPreset
+GstPresetInterface
 gst_preset_get_preset_names
 gst_preset_get_property_names
 gst_preset_load_preset
@@ -1699,7 +1700,6 @@ gst_preset_delete_preset
 gst_preset_set_meta
 gst_preset_get_meta
 <SUBSECTION Standard>
-GstPresetInterface
 GST_PRESET
 GST_IS_PRESET
 GST_TYPE_PRESET

diff --git a/gst/gstpreset.h b/gst/gstpreset.h
index f84677a..ef071a2 100644 (file)
--- a/gst/gstpreset.h
+++ b/gst/gstpreset.h
@@ -32,14 +32,33 @@ G_BEGIN_DECLS
 #define GST_IS_PRESET(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PRESET))
 #define GST_PRESET_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_PRESET, GstPresetInterface))
 
-
+/**
+ * GstPreset:
+ *
+ * Opaque #GstPreset data structure.
+ */
 typedef struct _GstPreset GstPreset; /* dummy object */
 typedef struct _GstPresetInterface GstPresetInterface;
 
+/**
+ * GstPresetInterface:
+ * @parent: parent interface type.
+ * @get_preset_names: virtual method to get list of presets
+ * @get_property_names: virtual methods to get properties that are persistent
+ * @load_preset: virtual methods to load a preset into properties
+ * @save_preset: virtual methods to save properties into a preset
+ * @rename_preset: virtual methods to rename a preset
+ * @delete_preset: virtual methods to remove a preset
+ * @set_meta: virtual methods to set textual meta data to a preset
+ * @get_meta: virtual methods to get textual meta data from a preset
+ *
+ * #GstPresetInterface interface.
+ */
 struct _GstPresetInterface
 {
   GTypeInterface parent;
 
+  /* methods */
   gchar**      (*get_preset_names)    (GstPreset *preset);
 
   gchar**      (*get_property_names)  (GstPreset *preset);