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.

diff --git a/gst/gstcaps.c b/gst/gstcaps.c
index 991cd47..b3755f2 100644 (file)
--- a/gst/gstcaps.c
+++ b/gst/gstcaps.c
@@ -1781,9 +1781,9 @@ gst_caps_replace (GstCaps ** caps, GstCaps * newcaps)
  * can be converted back to a #GstCaps by gst_caps_from_string().
  *
  * For debugging purposes its easier to do something like this:
- * <programlisting>
- *  GST_LOG ("caps are %" GST_PTR_FORMAT, caps);
- * </programlisting>
+ * |[
+ * GST_LOG ("caps are %" GST_PTR_FORMAT, caps);
+ * ]|
  * This prints the caps in human readble form.
  *
  * Returns: a newly allocated string representing @caps.

diff --git a/gst/gststructure.c b/gst/gststructure.c
index e620dae..93d509f 100644 (file)
--- 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.
  */