Small documentation updates

Original commit message from CVS:
Small documentation updates

diff --git a/TODO b/TODO
index e3098f1..0cd1e74 100644 (file)
--- a/TODO
+++ b/TODO
@@ -9,7 +9,7 @@ before changes are accepted.
 
 target release ! description
                !
-    ?          ! expose and API to query the supported seek formats/flags on
+  0.4.1        ! expose and API to query the supported seek formats/flags on
                ! pads, somthing like an extra arg to gst_pad_set_convert_function
                ! and gst_pad_set_event_function with some function to query the 
                ! flags and formats. more ideas in docs/random/wtay/query_events

diff --git a/gst/gst.c b/gst/gst.c
index ccff3cf..02de29d 100644 (file)
--- a/gst/gst.c
+++ b/gst/gst.c
@@ -509,12 +509,28 @@ init_popt_callback (poptContext context, enum poptCallbackReason reason,
   }
 }
 
+/**
+ * gst_use_threads:
+ * @use_threads: flag indicating threads should be used
+ *
+ * Instructs the core to turn on/off threading. When threading
+ * is turned off, all thread operations such as mutexes and conditionals
+ * are turned into NOPs. use this if you want absolute minimal overhead
+ * and you don't use any threads in the pipeline.
+ */
 void
 gst_use_threads (gboolean use_threads)
 {
   _gst_use_threads = use_threads;
 }
 
+/**
+ * gst_has_threads:
+ * 
+ * Query if GStreamer has threads enabled.
+ *
+ * Returns: TRUE if threads are enabled.
+ */
 gboolean
 gst_has_threads (void)
 {