From 09d5ff4097d94cc176f8f3d1320bbf12beee7658 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= Date: Tue, 14 Jun 2016 19:16:33 +0100 Subject: [PATCH] info: flesh out GST_PTR_FORMAT docs a bit --- gst/gstinfo.h | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/gst/gstinfo.h b/gst/gstinfo.h index 3b7ccd5084..27c3f9df85 100644 --- a/gst/gstinfo.h +++ b/gst/gstinfo.h @@ -262,7 +262,15 @@ struct _GstDebugCategory { /** * GST_PTR_FORMAT: * - * printf format type used to debug GStreamer types. + * printf format type used to debug GStreamer types. You can use this in + * combination with GStreamer's debug logging system as well as the functions + * gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf() + * to pretty-print the following types: #GstCaps, #GstStructure, + * #GstCapsFeatures, #GstTagList, #GstDateTime, #GstBuffer, #GstBufferList, + * #GstMessage, #GstEvent, #GstQuery, #GstContext, #GstPad, #GstObject. All + * #GObject types will be printed as typename plus pointer, and everything + * else will simply be printed as pointer address. + * * This can only be used on types whose size is >= sizeof(gpointer). */ #define GST_PTR_FORMAT "p\aA" @@ -270,7 +278,10 @@ struct _GstDebugCategory { /** * GST_SEGMENT_FORMAT: * - * printf format type used to debug GStreamer segments. + * printf format type used to debug GStreamer segments. You can use this in + * combination with GStreamer's debug logging system as well as the functions + * gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf() + * to pretty-print #GstSegment structures. * This can only be used on pointers to GstSegment structures. */ #define GST_SEGMENT_FORMAT "p\aB"