From eb6ba249c43a0c6ecdad0a6aa3b3e56e9eebee84 Mon Sep 17 00:00:00 2001
From: Edward Hervey <edward@centricular.com>
Date: Tue, 5 Dec 2017 18:20:34 +0100
Subject: [PATCH] docs: Add documentation for GST_SEQNUM_INVALID

And link to it
---
 docs/gst/gstreamer-sections.txt |  1 +
 gst/gstutils.c                  |  2 +-
 gst/gstutils.h                  | 10 ++++++++++
 3 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 52443e18fb..f850d582e4 100644
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -3571,6 +3571,7 @@ GFLOAT_FROM_LE
 GFLOAT_SWAP_LE_BE
 GFLOAT_TO_BE
 GFLOAT_TO_LE
+GST_SEQNUM_INVALID
 GST_GROUP_ID_INVALID
 
 gst_guint64_to_gdouble
diff --git a/gst/gstutils.c b/gst/gstutils.c
index be45dec0ff..447fcf87db 100644
--- a/gst/gstutils.c
+++ b/gst/gstutils.c
@@ -788,7 +788,7 @@ gst_util_uint64_scale_int_ceil (guint64 val, gint num, gint denom)
  * on a segment-done message to be the same as that of the last seek event, to
  * indicate that event and the message correspond to the same segment.
  *
- * This function never returns GST_SEQNUM_INVALID (which is 0).
+ * This function never returns %GST_SEQNUM_INVALID (which is 0).
  *
  * Returns: A constantly incrementing 32-bit unsigned integer, which might
  * overflow at some point. Use gst_util_seqnum_compare() to make sure
diff --git a/gst/gstutils.h b/gst/gstutils.h
index a9b9eee881..50540961a4 100644
--- a/gst/gstutils.h
+++ b/gst/gstutils.h
@@ -99,6 +99,16 @@ guint64         gst_util_uint64_scale_int_round (guint64 val, gint num, gint den
 GST_EXPORT
 guint64         gst_util_uint64_scale_int_ceil  (guint64 val, gint num, gint denom);
 
+/**
+ * GST_SEQNUM_INVALID:
+ *
+ * A value which is guaranteed to never be returned by
+ * gst_util_seqnum_next().
+ *
+ * Can be used as a default value in variables used to store seqnum.
+ *
+ * Since: 1.14
+ */
 #define GST_SEQNUM_INVALID (0)
 
 GST_EXPORT