gst: Add an example to GST_STATIC_PAD_TEMPLATE macro
authorEdward Hervey <edward@centricular.com>
Mon, 21 May 2018 09:16:29 +0000 (11:16 +0200)
committerEdward Hervey <bilboed@bilboed.com>
Mon, 21 May 2018 09:17:30 +0000 (11:17 +0200)
gst/gstpadtemplate.h

index e3d0bc5..fb15c40 100644 (file)
@@ -178,8 +178,14 @@ struct _GstStaticPadTemplate {
  * @pres: the GstPadPresence of the pad
  * @caps: the GstStaticCaps of the pad
  *
- * Convenience macro to fill the values of a GstStaticPadTemplate
+ * Convenience macro to fill the values of a #GstStaticPadTemplate
  * structure.
+ * Example:
+ * |[<!-- language="C" -->
+ * static GstStaticPadTemplate my_src_template = \
+ *   GST_STATIC_PAD_TEMPLATE("src", GST_PAD_SRC, GST_PAD_ALWAYS,
+ *                           GST_STATIC_CAPS_ANY);
+ * ]|
  */
 #define GST_STATIC_PAD_TEMPLATE(padname, dir, pres, caps) \
 { \