Added some more docs

Original commit message from CVS:
Added some more docs

diff --git a/gst/gstelement.c b/gst/gstelement.c
index bcf8d50..e180f02 100644 (file)
--- a/gst/gstelement.c
+++ b/gst/gstelement.c
@@ -798,6 +798,12 @@ gst_element_wait_done (GstElement *element, GstElementState old, GstElementState
   g_cond_signal (cond);
 }
 
+/**
+ * gst_element_wait_state_change:
+ * @element: element wait for
+ *
+ * Wait and block until the element changed its state.
+ */
 void
 gst_element_wait_state_change (GstElement *element)
 {

diff --git a/gst/gstpad.c b/gst/gstpad.c
index a0d6558..19be16b 100644 (file)
--- a/gst/gstpad.c
+++ b/gst/gstpad.c
@@ -1956,6 +1956,13 @@ gst_ghost_pad_new (gchar *name,
 }
 
 
+/**
+ * gst_pad_event_default:
+ * @pad: the pad to operate on
+ * @event: the event to handle
+ *
+ * Invoke the default event handler for the given pad.
+ */
 void 
 gst_pad_event_default (GstPad *pad, GstEvent *event)
 {

diff --git a/gst/gstscheduler.c b/gst/gstscheduler.c
index d11c934..7166646 100644 (file)
--- a/gst/gstscheduler.c
+++ b/gst/gstscheduler.c
@@ -169,6 +169,13 @@ gst_scheduler_remove_element (GstScheduler *sched, GstElement *element)
     CLASS (sched)->remove_element (sched, element);
 }
 
+/**
+ * gst_scheduler_lock_element:
+ * @sched: the schedulerr
+ * @element: the element to lock
+ *
+ * Acquire a lock on the given element in the given scheduler.
+ */
 void
 gst_scheduler_lock_element (GstScheduler *sched, GstElement *element)
 {
@@ -176,6 +183,13 @@ gst_scheduler_lock_element (GstScheduler *sched, GstElement *element)
     CLASS (sched)->lock_element (sched, element);
 }
 
+/**
+ * gst_scheduler_unlock_element:
+ * @sched: the schedulerr
+ * @element: the element to unlock
+ *
+ * Release the lock on the given element in the given scheduler.
+ */
 void
 gst_scheduler_unlock_element (GstScheduler *sched, GstElement *element)
 {
@@ -373,9 +387,10 @@ gst_schedulerfactory_get_list (void)
 /**
  * gst_schedulerfactory_create:
  * @factory: the factory used to create the instance
+ * @parent: the parent element of this scheduler
  *
  * Create a new #GstScheduler instance from the 
- * given schedulerfactory.
+ * given schedulerfactory with the given parent.
  *
  * Returns: A new #GstScheduler instance.
  */
@@ -399,9 +414,10 @@ gst_schedulerfactory_create (GstSchedulerFactory *factory, GstElement *parent)
 /**
  * gst_schedulerfactory_make:
  * @name: the name of the factory used to create the instance
+ * @parent: the parent element of this scheduler
  *
  * Create a new #GstScheduler instance from the 
- * schedulerfactory with the given name.
+ * schedulerfactory with the given name and parent.
  *
  * Returns: A new #GstScheduler instance.
  */