docs: add the tracer to the docs

Add GstTracer and GstTracerFactory to the core docs.

diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index cacfd9c..cf476cd 100644 (file)
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -32,7 +32,7 @@ GStreamer is cross-platform and works on most UNIX-like platforms as well as
 Windows.  It is released under the GNU Library General Public License
 (GNU LGPL).
     </para>
-    
+
     <mediaobject>
       <imageobject>
         <imagedata fileref="gst-universe.svg" format="SVG"/>
@@ -133,6 +133,8 @@ Windows.  It is released under the GNU Library General Public License
     </para>
 
     <xi:include href="xml/gstinfo.xml" />
+    <xi:include href="xml/gsttracer.xml" />
+    <xi:include href="xml/gsttracerfactory.xml" />
 
   </chapter>
 
@@ -173,7 +175,7 @@ Windows.  It is released under the GNU Library General Public License
     <title>Index of new API in 1.0.5</title>
     <xi:include href="xml/api-index-1.0.5.xml"><xi:fallback /></xi:include>
   </index>
-  
+
   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 
 </book>

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 369db8f..9177792 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -3032,6 +3032,44 @@ gst_toc_scope_get_type
 
 
 <SECTION>
+<FILE>gsttracer</FILE>
+<TITLE>GstTracer</TITLE>
+GstTracer
+gst_tracer_register
+gst_tracing_register_hook
+gst_tracing_register_hook_id
+gst_tracer_log_trace
+<SUBSECTION Standard>
+GST_TRACER
+GST_IS_TRACER
+GST_TYPE_TRACER
+GST_TRACER_CLASS
+GST_IS_TRACER_CLASS
+GST_TRACER_GET_CLASS
+<SUBSECTION Private>
+gst_tracer_get_type
+</SECTION>
+
+
+<SECTION>
+<FILE>gsttracerfactory</FILE>
+<TITLE>GstTracerFactory</TITLE>
+GstTracerFactory
+gst_tracer_factory_get_list
+<SUBSECTION Standard>
+GstTracerFactoryClass
+GST_TRACER_FACTORY
+GST_IS_TYPE_TRACER
+GST_TYPE_TRACER_CLASS
+GST_IS_TRACER_FACTORY_CLASS
+GST_TYPE_TRACER_GET_CLASS
+GST_TYPE_TRACER_FACTORY
+<SUBSECTION Private>
+gst_tracer_factory_get_type
+</SECTION>
+
+
+<SECTION>
 <FILE>gsttocsetter</FILE>
 <TITLE>GstTocSetter</TITLE>
 GstTocSetter

diff --git a/docs/gst/gstreamer.types.in b/docs/gst/gstreamer.types.in
index a79f385..e4c2e8f 100644 (file)
--- a/docs/gst/gstreamer.types.in
+++ b/docs/gst/gstreamer.types.in
@@ -28,6 +28,8 @@ gst_registry_get_type
 gst_system_clock_get_type
 gst_tag_setter_get_type
 gst_task_get_type
+gst_tracer_get_type
+gst_tracer_factory_get_type
 gst_type_find_factory_get_type
 gst_uri_handler_get_type
 

diff --git a/gst/gsttracer.c b/gst/gsttracer.c
index f1806f6..8cb9357 100644 (file)
--- a/gst/gsttracer.c
+++ b/gst/gsttracer.c
@@ -24,9 +24,9 @@
  * @short_description: Tracing base class
  *
  * 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.
+ * gst_tracing_register(). Modules can attach to various hook-types - see
+ * gst_tracing_register_hook(). When invoked they receive hook specific
+ * contextual data, which they must not modify.
  *
  * Since: 1.8
  */
@@ -130,6 +130,17 @@ gst_tracer_get_property (GObject * object, guint prop_id,
 
 /* tracing modules */
 
+/**
+ * gst_tracer_register:
+ * @plugin: (allow-none): A #GstPlugin, or %NULL for a static typefind function
+ * @name: The name for registering
+ * @type: GType of tracer to register
+ *
+ * Create a new tracer-factory  capable of instantiating objects of the
+ * @type and add the factory to @plugin.
+ *
+ * Returns: %TRUE, if the registering succeeded, %FALSE on error
+ */
 gboolean
 gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type)
 {
@@ -186,6 +197,17 @@ gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type)
 
 /* tracing module helpers */
 
+/**
+ * gst_tracer_log_trace:
+ *
+ * Default log hander for traces. Serialzed the trace event into the log.
+ *
+ * Right now this is using the gstreamer debug log with the level TRACE (7) and
+ * the category "GST_TRACER".
+ * <note><para>
+ *   Please note that this is still under discussion and subject to change.
+ * </para></note>
+ */
 void
 gst_tracer_log_trace (GstStructure * s)
 {