Port gtk-doc comments to their equivalent markdown syntax

[platform/upstream/gstreamer.git] / gst / gstclock.h

diff --git a/gst/gstclock.h b/gst/gstclock.h
index 517444d..6ec461a 100644 (file)
--- a/gst/gstclock.h
+++ b/gst/gstclock.h
@@ -24,6 +24,9 @@
 #ifndef __GST_CLOCK_H__
 #define __GST_CLOCK_H__
 
+#include <gst/gstconfig.h>
+#include <glib.h>
+
 G_BEGIN_DECLS
 
 /* --- standard type macros --- */
@@ -88,7 +91,7 @@ typedef gpointer GstClockID;
  *
  * Tests if a given #GstClockTimeDiff of #gint64 represents a valid defined time.
  *
- * Since 1.6
+ * Since: 1.6
  */
 #define GST_CLOCK_STIME_IS_VALID(time)   (((GstClockTimeDiff)(time)) != GST_CLOCK_STIME_NONE)
 
@@ -106,7 +109,7 @@ typedef gpointer GstClockID;
  */
 #define GST_MSECOND (GST_SECOND / G_GINT64_CONSTANT (1000))
 /**
- * GST_USECOND: (alue: 1000) (type GstClockTime)
+ * GST_USECOND: (value 1000) (type GstClockTime)
  *
  * Constant that defines one GStreamer microsecond.
  */
@@ -173,9 +176,9 @@ typedef gpointer GstClockID;
  *
  * Convert a #GstClockTime to a #GTimeVal
  *
- * <note>on 32-bit systems, a timeval has a range of only 2^32 - 1 seconds,
- * which is about 68 years.  Expect trouble if you want to schedule stuff
- * in your pipeline for 2038.</note>
+ * > on 32-bit systems, a timeval has a range of only 2^32 - 1 seconds,
+ * > which is about 68 years.  Expect trouble if you want to schedule stuff
+ * > in your pipeline for 2038.
  */
 #define GST_TIME_TO_TIMEVAL(t,tv)                               \
 G_STMT_START {                                                  \
@@ -218,7 +221,7 @@ G_STMT_START {                                                    \
  * the matching arguments.
  *
  * Example:
- * |[
+ * |[<!-- language="C" -->
  * printf("%" GST_TIME_FORMAT "\n", GST_TIME_ARGS(ts));
  * ]|
  */
@@ -251,9 +254,9 @@ G_STMT_START {                                                    \
  * printf("%" GST_STIME_FORMAT "\n", GST_STIME_ARGS(ts));
  * ]|
  *
- * Since 1.6
+ * Since: 1.6
  */
-#define GST_STIME_FORMAT "d:%02u:%02u.%09u"
+#define GST_STIME_FORMAT "c%" GST_TIME_FORMAT
 /**
  * GST_STIME_ARGS:
  * @t: a #GstClockTimeDiff or #gint64
@@ -261,17 +264,18 @@ G_STMT_START {                                                    \
  * Format @t for the #GST_STIME_FORMAT format string. Note: @t will be
  * evaluated more than once.
  *
- * Since 1.6
+ * Since: 1.6
  */
-#define GST_STIME_ARGS(t) \
-        GST_CLOCK_STIME_IS_VALID (t) ? \
-        (gint) ((GstClockTimeDiff)(t) / (GST_SECOND * 60 * 60)) : -99, \
-        GST_CLOCK_STIME_IS_VALID (t) ? \
-        (guint) ((((GstClockTime)ABS(t)) / (GST_SECOND * 60)) % 60) : 99, \
-        GST_CLOCK_STIME_IS_VALID (t) ? \
-        (guint) ((((GstClockTime)ABS(t)) / GST_SECOND) % 60) : 99, \
-        GST_CLOCK_STIME_IS_VALID (t) ? \
-        (guint) (((GstClockTime)ABS(t)) % GST_SECOND) : 999999999
+#define GST_STIME_ARGS(t)                                              \
+  ((t) == GST_CLOCK_STIME_NONE || (t) >= 0) ? '+' : '-',               \
+    GST_CLOCK_STIME_IS_VALID (t) ?                                     \
+    (guint) (((GstClockTime)(ABS(t))) / (GST_SECOND * 60 * 60)) : 99,  \
+    GST_CLOCK_STIME_IS_VALID (t) ?                                     \
+    (guint) ((((GstClockTime)(ABS(t))) / (GST_SECOND * 60)) % 60) : 99,        \
+    GST_CLOCK_STIME_IS_VALID (t) ?                                     \
+    (guint) ((((GstClockTime)(ABS(t))) / GST_SECOND) % 60) : 99,       \
+    GST_CLOCK_STIME_IS_VALID (t) ?                                     \
+    (guint) (((GstClockTime)(ABS(t))) % GST_SECOND) : 999999999
 
 typedef struct _GstClockEntry   GstClockEntry;
 typedef struct _GstClock        GstClock;
@@ -410,7 +414,7 @@ struct _GstClockEntry {
  * @GST_CLOCK_FLAG_CAN_SET_RESOLUTION: clock's resolution can be changed
  * @GST_CLOCK_FLAG_CAN_SET_MASTER: clock can be slaved to a master clock
  * @GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC: clock needs to be synced before it can be used
- *     Since: 1.6
+ *     (Since 1.6)
  * @GST_CLOCK_FLAG_LAST: subclasses can add additional flags starting from this flag
  *
  * The capabilities of this clock
@@ -531,6 +535,12 @@ GstClockTime            gst_clock_adjust_with_calibration (GstClock *clock,
                                                          GstClockTime cexternal,
                                                          GstClockTime cnum,
                                                          GstClockTime cdenom);
+GstClockTime            gst_clock_unadjust_with_calibration (GstClock *clock,
+                                                         GstClockTime external_target,
+                                                         GstClockTime cinternal,
+                                                         GstClockTime cexternal,
+                                                         GstClockTime cnum,
+                                                         GstClockTime cdenom);
 GstClockTime            gst_clock_unadjust_unlocked     (GstClock * clock, GstClockTime external);
 
 /* waiting for, signalling and checking for synchronization */
@@ -571,6 +581,10 @@ gboolean                gst_clock_periodic_id_reinit    (GstClock * clock,
                                                          GstClockTime start_time,
                                                          GstClockTime interval);
 
+#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstClock, gst_object_unref)
+#endif
+
 G_END_DECLS
 
 #endif /* __GST_CLOCK_H__ */