summaryrefslogtreecommitdiff
path: root/libs/gst/check/gsttestclock.c
diff options
context:
space:
mode:
Diffstat (limited to 'libs/gst/check/gsttestclock.c')
-rw-r--r--libs/gst/check/gsttestclock.c29
1 files changed, 14 insertions, 15 deletions
diff --git a/libs/gst/check/gsttestclock.c b/libs/gst/check/gsttestclock.c
index 513667fd3..ab90e49d4 100644
--- a/libs/gst/check/gsttestclock.c
+++ b/libs/gst/check/gsttestclock.c
@@ -23,6 +23,7 @@
/**
* SECTION:gsttestclock
+ * @title: GstTestClock
* @short_description: Controllable, deterministic clock for GStreamer unit tests
* @see_also: #GstSystemClock, #GstClock
*
@@ -34,11 +35,11 @@
* precisely advance the time in a deterministic manner, independent of the
* system time or any other external factors.
*
- * <example>
- * <title>Advancing the time of a #GstTestClock</title>
- * <programlisting language="c">
- * #include &lt;gst/gst.h&gt;
- * #include &lt;gst/check/gsttestclock.h&gt;
+ * ## Advancing the time of a #GstTestClock
+ *
+ * |[<!-- language="C" -->
+ * #include <gst/gst.h>
+ * #include <gst/check/gsttestclock.h>
*
* GstClock *clock;
* GstTestClock *test_clock;
@@ -53,8 +54,7 @@
* gst_test_clock_set_time (test_clock, 42 * GST_SECOND);
* GST_INFO ("Time: %" GST_TIME_FORMAT, GST_TIME_ARGS (gst_clock_get_time (clock)));
* ...
- * </programlisting>
- * </example>
+ * ]|
*
* #GstClock allows for setting up single shot or periodic clock notifications
* as well as waiting for these notifications synchronously (using
@@ -93,12 +93,12 @@
* second buffer will arrive a little late (7ms) due to simulated jitter in the
* clock notification.
*
- * <example>
- * <title>Demonstration of how to work with clock notifications and #GstTestClock</title>
- * <programlisting language="c">
- * #include &lt;gst/gst.h&gt;
- * #include &lt;gst/check/gstcheck.h&gt;
- * #include &lt;gst/check/gsttestclock.h&gt;
+ * ## Demonstration of how to work with clock notifications and #GstTestClock
+ *
+ * |[<!-- language="C" -->
+ * #include <gst/gst.h>
+ * #include <gst/check/gstcheck.h>
+ * #include <gst/check/gsttestclock.h>
*
* GstClockTime latency;
* GstElement *element;
@@ -166,8 +166,7 @@
* GST_INFO ("Check that element does not wait for any clock notification\n");
* g_assert (!gst_test_clock_peek_next_pending_id (test_clock, NULL));
* ...
- * </programlisting>
- * </example>
+ * ]|
*
* Since #GstTestClock is only supposed to be used in unit tests it calls
* g_assert(), g_assert_cmpint() or g_assert_cmpuint() to validate all function