summaryrefslogtreecommitdiff
path: root/gst/gststructure.c
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2009-03-06 21:59:20 +0200
committerStefan Kost <ensonic@users.sf.net>2009-03-06 21:59:20 +0200
commit1ec60ae3927dc1671499c3ba254e6a85fa26b5ac (patch)
tree7d03e9561392ba3499f6168b9774f5f4e854290a /gst/gststructure.c
parent436b0e72752e3bad45dd26f1d51b542d66334cc4 (diff)
apidocs: markup example as highlightable example and copy same for structure
structures can be printed like we can do for caps. Mark the example so that gtk-doc can pretty print and xref it.
Diffstat (limited to 'gst/gststructure.c')
-rw-r--r--gst/gststructure.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/gst/gststructure.c b/gst/gststructure.c
index e620dae09..93d509fbd 100644
--- a/gst/gststructure.c
+++ b/gst/gststructure.c
@@ -1546,6 +1546,12 @@ priv_gst_structure_append_to_gstring (const GstStructure * structure,
*
* Converts @structure to a human-readable string representation.
*
+ * For debugging purposes its easier to do something like this:
+ * |[
+ * GST_LOG ("structure is %" GST_PTR_FORMAT, structure);
+ * ]|
+ * This prints the structure in human readble form.
+ *
* Returns: a pointer to string allocated by g_malloc(). g_free() after
* usage.
*/