added some long description to gstcontrol

Original commit message from CVS:
added some long description to gstcontrol

diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml
index 6f00a39..ac1f4d6 100644 (file)
--- a/docs/libs/gstreamer-libs-docs.sgml
+++ b/docs/libs/gstreamer-libs-docs.sgml
@@ -10,9 +10,8 @@
 <!ENTITY GstControl SYSTEM "xml/gstcontrol.xml">
 <!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">
 
+<!ENTITY hash "#">
 ]>
-
-
 <book>
   <bookinfo>
     <title>GStreamer Library &GST_MAJORMINOR; API Reference (&GST_VERSION;)</title>

diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt
index 14da64b..cbe531b 100644 (file)
--- a/docs/libs/gstreamer-libs-sections.txt
+++ b/docs/libs/gstreamer-libs-sections.txt
@@ -115,6 +115,9 @@ gst_dpman_attach_dparam
 gst_dpman_detach_dparam
 gst_dpman_get_dparam
 gst_dpman_get_dparam_type
+gst_dpman_list_dparam_specs
+gst_dpman_get_param_spec
+gst_dpman_set_rate
 gst_dpman_register_mode
 gst_dpman_set_mode
 gst_dpman_set_parent

diff --git a/docs/libs/tmpl/gstcontrol.sgml b/docs/libs/tmpl/gstcontrol.sgml
index abb4e2e..534e257 100644 (file)
--- a/docs/libs/tmpl/gstcontrol.sgml
+++ b/docs/libs/tmpl/gstcontrol.sgml
@@ -6,7 +6,26 @@ Dynamic parameter functionality
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
+This library provides a Manager that maintains a list of dynamically
+controlable parameters for a GstElement.
+Just think of a volume slider in a mixer.
+</para>
 
+<para>
+To use this library one needs to add some code to initialize it.
+<example>
+<title>Adding the control library to a project</title>
+<programlisting>
+...
+&hash;include &lt;gst/gst.h&gt;
+&hash;include &lt;gst/control/control.h&gt;
+...
+gst_init(&amp;argc,&amp;argv);
+gst_control_init(&amp;argc,&amp;argv);
+...
+</programlisting>
+</example>
+The next step is to get hold of the GstDParamManager instance of a GstElement.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -105,8 +124,10 @@ Dynamic parameter functionality
 </para>
 
 @dpman: 
-@name: 
+@dparam_name: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@name: 
 
 
 <!-- ##### FUNCTION gst_dpman_get_dparam_type ##### -->
@@ -115,10 +136,40 @@ Dynamic parameter functionality
 </para>
 
 @dpman: 
+@dparam_name: 
+@Returns: 
+<!-- # Unused Parameters # -->
 @name: 
+
+
+<!-- ##### FUNCTION gst_dpman_list_dparam_specs ##### -->
+<para>
+
+</para>
+
+@dpman: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_dpman_get_param_spec ##### -->
+<para>
+
+</para>
+
+@dpman: 
+@dparam_name: 
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_dpman_set_rate ##### -->
+<para>
+
+</para>
+
+@dpman: 
+@rate: 
+
+
 <!-- ##### FUNCTION gst_dpman_register_mode ##### -->
 <para>