gst/gstdebugutils.h: Mention GstDebugGraphDetails enum type in doc blurb so we get...

Original commit message from CVS:
* gst/gstdebugutils.h: (GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS),
(GST_DEBUG_BIN_TO_DOT_FILE):
Mention GstDebugGraphDetails enum type in doc blurb so we get a link
to it in the docs (since these are macros the types of the arguments
won't be shown in the docs otherwise).

diff --git a/ChangeLog b/ChangeLog
index 1363b6c..68e2b28 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2008-04-10  Tim-Philipp Müller  <tim at centricular dot net>
+
+       * gst/gstdebugutils.h: (GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS),
+         (GST_DEBUG_BIN_TO_DOT_FILE):
+         Mention GstDebugGraphDetails enum type in doc blurb so we get a link
+         to it in the docs (since these are macros the types of the arguments
+         won't be shown in the docs otherwise).
+
 2008-04-10  Stefan Kost  <ensonic@users.sf.net>
 
        * gst/gstpad.c:

diff --git a/gst/gstdebugutils.h b/gst/gstdebugutils.h
index c84643d..9c0d82f 100644 (file)
--- a/gst/gstdebugutils.h
+++ b/gst/gstdebugutils.h
@@ -59,7 +59,8 @@ void _gst_debug_bin_to_dot_file_with_ts (GstBin *bin, GstDebugGraphDetails detai
 /**
  * GST_DEBUG_BIN_TO_DOT_FILE:
  * @bin: the top-level pipeline that should be analyzed
- * @details: graph-details to show
+ * @details: details to show in the graph, e.g. #GST_DEBUG_GRAPH_SHOW_ALL or
+ *    one or more other #GstDebugGraphDetails flags.
  * @file_name: output base filename (e.g. "myplayer")
  *
  * To aid debugging applications one can use this method to write out the whole
@@ -78,7 +79,8 @@ void _gst_debug_bin_to_dot_file_with_ts (GstBin *bin, GstDebugGraphDetails detai
 /**
  * GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS:
  * @bin: the top-level pipeline that should be analyzed
- * @details: graph-details to show
+ * @details: details to show in the graph, e.g. #GST_DEBUG_GRAPH_SHOW_ALL or
+ *    one or more other #GstDebugGraphDetails flags.
  * @file_name: output base filename (e.g. "myplayer")
  *
  * This works like _gst_debug_bin_to_dot_file(), but adds the current timestamp