summaryrefslogtreecommitdiff
path: root/gst/gstcaps.h
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2011-05-02 15:52:58 +0300
committerStefan Kost <ensonic@users.sf.net>2011-05-03 13:03:20 +0300
commit319eef8aa978491c9e7082add7258d5335b5bde7 (patch)
tree40c0f1da65421ed32210209c6e5173843bc16e63 /gst/gstcaps.h
parent41754faaaf22553a45c7d52b0d47036f7f2f9675 (diff)
docs: improve the syntax for the capsintersectmode docs
Diffstat (limited to 'gst/gstcaps.h')
-rw-r--r--gst/gstcaps.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/gst/gstcaps.h b/gst/gstcaps.h
index 398fa3fcb..f79939c61 100644
--- a/gst/gstcaps.h
+++ b/gst/gstcaps.h
@@ -49,20 +49,21 @@ typedef enum {
* @GST_CAPS_INTERSECT_FIRST : Keeps the first caps order.
*
* Modes of caps intersection
- *
- * #GST_CAPS_INTERSECT_ZIG_ZAG tries to preserve overall order of both caps
+ *
+ * @GST_CAPS_INTERSECT_ZIG_ZAG tries to preserve overall order of both caps
* by iterating on the caps' structures as the following matrix shows:
+ * |[
* caps1
* +-------------
* | 1 2 4 7
* caps2 | 3 5 8 10
* | 6 9 11 12
- *
+ * ]|
* Used when there is no explicit precedence of one caps over the other. e.g.
* tee's sink pad getcaps function, it will probe its src pad peers' for their
* caps and intersect them with this mode.
*
- * #GST_CAPS_INTERSECT_FIRST is useful when an element wants to preserve
+ * @GST_CAPS_INTERSECT_FIRST is useful when an element wants to preserve
* another element's caps priority order when intersecting with its own caps.
* Example: If caps1 is [A, B, C] and caps2 is [E, B, D, A], the result
* would be [A, B], maintaining the first caps priority on the intersection.