From 646ca1edbe5510d67e5ca7767d99e210ec8b946b Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Thu, 15 Jul 2004 13:20:54 +0000 Subject: [PATCH] now the api-index has a title in devhelp added more docs for the control-library added personal thoughs/todo to docs/... Original commit message from CVS: now the api-index has a title in devhelp added more docs for the control-library added personal thoughs/todo to docs/random --- docs/gst/gstreamer-docs.sgml | 4 +++- docs/gst/tmpl/gstelement.sgml | 23 +++++++++++++++++++ docs/gst/tmpl/gsttypes.sgml | 32 +++++++++++++-------------- docs/libs/gstreamer-libs-docs.sgml | 11 ++++++++- docs/libs/gstreamer-libs-sections.txt | 1 + docs/libs/tmpl/gstcontrol.sgml | 9 ++++++++ docs/random/ensonic/dparams.txt | 11 +++++++++ libs/gst/control/dparam.c | 11 +++++++++ libs/gst/control/dparam_smooth.c | 2 ++ 9 files changed, 86 insertions(+), 18 deletions(-) create mode 100644 docs/random/ensonic/dparams.txt diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 241d8a6618..af052c9d50 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -162,6 +162,8 @@ with some more specialized elements. &gstreamer-tree-index; - + + API Index + diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 2a07afc6df..6263b4e824 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -76,6 +76,8 @@ and gst_element_set_clock(). You can wait for the clock to reach a given +@: + @gstelement: the object which received the signal. @@ -83,6 +85,11 @@ and gst_element_set_clock(). You can wait for the clock to reach a given +@: +@: +@: +@: + @gstelement: the object which received the signal. @arg1: @arg2: @@ -93,6 +100,10 @@ and gst_element_set_clock(). You can wait for the clock to reach a given +@: +@: +@: + @gstelement: the object which received the signal. @arg1: @arg2: @@ -102,6 +113,9 @@ and gst_element_set_clock(). You can wait for the clock to reach a given +@: +@: + @gstelement: the object which received the signal. @arg1: @@ -110,6 +124,8 @@ and gst_element_set_clock(). You can wait for the clock to reach a given +@: + @gstelement: the object which received the signal. @@ -117,6 +133,9 @@ and gst_element_set_clock(). You can wait for the clock to reach a given +@: +@: + @gstelement: the object which received the signal. @arg1: @@ -125,6 +144,10 @@ and gst_element_set_clock(). You can wait for the clock to reach a given +@: +@: +@: + @gstelement: the object which received the signal. @arg1: @arg2: diff --git a/docs/gst/tmpl/gsttypes.sgml b/docs/gst/tmpl/gsttypes.sgml index b78624314b..dcf6af2d83 100644 --- a/docs/gst/tmpl/gsttypes.sgml +++ b/docs/gst/tmpl/gsttypes.sgml @@ -127,58 +127,58 @@ template. -@: +@gstelement: the object which received the signal. -@: -@: -@: -@: +@gstelement: the object which received the signal. +@arg1: +@arg2: +@arg3: -@: -@: -@: +@gstelement: the object which received the signal. +@arg1: +@arg2: -@: -@: +@gstelement: the object which received the signal. +@arg1: -@: +@gstelement: the object which received the signal. -@: -@: +@gstelement: the object which received the signal. +@arg1: -@: -@: -@: +@gstelement: the object which received the signal. +@arg1: +@arg2: diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml index 14d151f243..538c2766b5 100644 --- a/docs/libs/gstreamer-libs-docs.sgml +++ b/docs/libs/gstreamer-libs-docs.sgml @@ -10,6 +10,8 @@ + + ]> @@ -35,6 +37,13 @@ - + + Object Hierarchy + &gstlibs-tree-index; + + + + API Index + diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt index cbe531b004..00b65308bc 100644 --- a/docs/libs/gstreamer-libs-sections.txt +++ b/docs/libs/gstreamer-libs-sections.txt @@ -128,4 +128,5 @@ gst_dparam_new gst_dparam_attach gst_dparam_detach gst_dparam_do_update_default +gst_dpsmooth_new diff --git a/docs/libs/tmpl/gstcontrol.sgml b/docs/libs/tmpl/gstcontrol.sgml index 534e257ad4..a6ae5bde12 100644 --- a/docs/libs/tmpl/gstcontrol.sgml +++ b/docs/libs/tmpl/gstcontrol.sgml @@ -259,3 +259,12 @@ The next step is to get hold of the GstDParamManager instance of a GstElement. @update_info: + + + + + +@type: +@Returns: + + diff --git a/docs/random/ensonic/dparams.txt b/docs/random/ensonic/dparams.txt new file mode 100644 index 0000000000..77a6cc6137 --- /dev/null +++ b/docs/random/ensonic/dparams.txt @@ -0,0 +1,11 @@ +$Id$ + +* cleanup of dparams + * resolve g_return_if_fail() into GST_WARNING and return() + in cases where the caller has to handle the problem + * rename + GST_TYPE_DPSMOOTH to GST_TYPE_DPARAM_SMOOTH + GST_TYPE_DP_LININT to GST_TYPE_DPARAM_LININT + there seems to be nobody using them, as they still look unfinished + +* concept for global, voice params diff --git a/libs/gst/control/dparam.c b/libs/gst/control/dparam.c index e731bcc862..f4fec2c38e 100644 --- a/libs/gst/control/dparam.c +++ b/libs/gst/control/dparam.c @@ -245,6 +245,17 @@ gst_dparam_set_property (GObject * object, guint prop_id, const GValue * value, GST_DPARAM_UNLOCK (dparam); } +/** + * gst_dparam_do_update_default: + * @dparam: + * @timestamp: + * @value: + * @update_info: + * + * Default implementation for changing a dynamic parameter. + * Subclasses might overwrite the behaviour of this. + * + */ void gst_dparam_do_update_default (GstDParam * dparam, gint64 timestamp, GValue * value, GstDParamUpdateInfo update_info) diff --git a/libs/gst/control/dparam_smooth.c b/libs/gst/control/dparam_smooth.c index d637971ccc..0f4d9db966 100644 --- a/libs/gst/control/dparam_smooth.c +++ b/libs/gst/control/dparam_smooth.c @@ -134,6 +134,8 @@ gst_dpsmooth_init (GstDParamSmooth * dpsmooth) * gst_dpsmooth_new: * @type: the type that this dparam will store * + * Create a new dynamic parameter controller which smoothes control changes. + * * Returns: a new instance of GstDParam */ GstDParam *