docs: add gtk-doc blobs

diff --git a/gst/gsttracer.c b/gst/gsttracer.c
index a57d420..065ca3a 100644 (file)
--- a/gst/gsttracer.c
+++ b/gst/gsttracer.c
@@ -19,6 +19,22 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:gsttracer
+ * @short_description: Tracing subsystem
+ *
+ * The tracing subsystem provides hooks in the core library and API for modules
+ * to attach to them.
+ *
+ * Tracing modules will subclass #GstTracer and register through
+ * gst_tracer_register(). Modules can attach to various hook-types - see
+ * #GstTracerHook. When invoked they receive hook specific contextual data, 
+ * which they must not modify.
+ *
+ * The user can activate tracers by setting the environment variable GST_TRACE
+ * to a ';' separated list of tracers.
+ */
+
 #include "gst_private.h"
 #include "gstenumtypes.h"
 #include "gstregistry.h"

diff --git a/gst/gsttracerfactory.c b/gst/gsttracerfactory.c
index 77d4925..9cdbb86 100644 (file)
--- a/gst/gsttracerfactory.c
+++ b/gst/gsttracerfactory.c
@@ -23,7 +23,8 @@
  * SECTION:gsttracerfactory
  * @short_description: Information about registered tracer functions
  *
- * Last reviewed on 2012-10-24 (1.2.X)
+ * Use gst_tracer_factory_get_list() to get a list of tracer factories known to
+ * GStreamer.
  */
 
 #include "gst_private.h"

diff --git a/plugins/tracers/gstlatency.c b/plugins/tracers/gstlatency.c
index c02af33..6e2ac3b 100644 (file)
--- a/plugins/tracers/gstlatency.c
+++ b/plugins/tracers/gstlatency.c
@@ -18,6 +18,13 @@
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:gstlatency
+ * @short_description: log processing latency stats
+ *
+ * A tracing module that determines src-to-sink latencies by injecting custom
+ * events at sources and process them at sinks. 
+ */
 /* TODO(ensonic): if there are two sources feeding into a mixer/muxer and later
  * we fan-out with tee and have two sinks, each sink would get all two events,
  * the later event would overwrite the former. Unfortunately when the buffer

diff --git a/plugins/tracers/gstlog.c b/plugins/tracers/gstlog.c
index 8cde6f9..982a9e9 100644 (file)
--- a/plugins/tracers/gstlog.c
+++ b/plugins/tracers/gstlog.c
@@ -18,6 +18,12 @@
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:gstlog
+ * @short_description: log hook event
+ *
+ * A tracing module that logs all data from all hooks. 
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"

diff --git a/plugins/tracers/gstrusage.c b/plugins/tracers/gstrusage.c
index 897feb8..22f1eb3 100644 (file)
--- a/plugins/tracers/gstrusage.c
+++ b/plugins/tracers/gstrusage.c
@@ -18,6 +18,12 @@
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:gstrusage
+ * @short_description: log resource usage stats
+ *
+ * A tracing module that take rusage() snapshots and logs them. 
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"

diff --git a/plugins/tracers/gststats.c b/plugins/tracers/gststats.c
index fdef85e..384a0ec 100644 (file)
--- a/plugins/tracers/gststats.c
+++ b/plugins/tracers/gststats.c
@@ -18,6 +18,12 @@
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:gstrusage
+ * @short_description: log event stats
+ *
+ * A tracing module that builds usage statistic for elements and pads. 
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"