gst-libs/gst/rtp/gstrtpbuffer.c: Fix the docs about the seqnum compare function,...

Original commit message from CVS:
* gst-libs/gst/rtp/gstrtpbuffer.c:
Fix the docs about the seqnum compare function, it returns a difference.

diff --git a/ChangeLog b/ChangeLog
index 4649500..f1cd331 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2008-04-25  Wim Taymans  <wim.taymans@collabora.co.uk>
+
+       * gst-libs/gst/rtp/gstrtpbuffer.c:
+       Fix the docs about the seqnum compare function, it returns a difference.
+
 2008-04-24  Edward Hervey  <edward.hervey@collabora.co.uk>
 
        * ext/alsa/gstalsadeviceprobe.c:

diff --git a/gst-libs/gst/rtp/gstrtpbuffer.c b/gst-libs/gst/rtp/gstrtpbuffer.c
index ab207a4..55193b7 100644 (file)
--- a/gst-libs/gst/rtp/gstrtpbuffer.c
+++ b/gst-libs/gst/rtp/gstrtpbuffer.c
@@ -1030,10 +1030,11 @@ gst_rtp_buffer_default_clock_rate (guint8 payload_type)
  * @seqnum1: a sequence number
  * @seqnum2: a sequence number
  *
- * Compare two sequence numbers, taking care of wraparounds.
+ * Compare two sequence numbers, taking care of wraparounds. This function
+ * returns the difference between @seqnum1 and @seqnum2.
  *
- * Returns: -1 if @seqnum1 is before @seqnum2, 0 if they are equal or 1 if
- * @seqnum1 is bigger than @segnum2.
+ * Returns: a negative value if @seqnum1 is before @seqnum2, 0 if they are equal
+ * or a positive value if  @seqnum1 is bigger than @segnum2.
  *
  * Since: 0.10.15
  */