From 0adf7303ecf08776205e85b5b65ee8bd3419945c Mon Sep 17 00:00:00 2001
From: "Timothy B. Terriberry" <tterribe@xiph.org>
Date: Fri, 12 May 2017 22:23:30 -0700
Subject: [PATCH] Minor documentation fix.
Clarify that the value returned by op_current_link() is strictly
less than the value returned by op_link_count() for seekable
sources.
---
include/opusfile.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/include/opusfile.h b/include/opusfile.h
index 94b89cf..74b85c2 100644
--- a/include/opusfile.h
+++ b/include/opusfile.h
@@ -1575,8 +1575,8 @@ const OpusTags *op_tags(const OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
\param _of The \c OggOpusFile from which to retrieve the current link index.
\return The index of the current link on success, or a negative value on
failure.
- For seekable streams, this is a number between 0 and the value
- returned by op_link_count().
+ For seekable streams, this is a number between 0 (inclusive) and the
+ value returned by op_link_count() (exclusive).
For unseekable streams, this value starts at 0 and increments by one
each time a new link is encountered (even though op_link_count()
always returns 1).
--
GitLab