Commit 0adf7303 authored by Timothy B. Terriberry's avatar Timothy B. Terriberry
Browse files

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.
parent 37f83754
...@@ -1575,8 +1575,8 @@ const OpusTags *op_tags(const OggOpusFile *_of,int _li) OP_ARG_NONNULL(1); ...@@ -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. \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 \return The index of the current link on success, or a negative value on
failure. failure.
For seekable streams, this is a number between 0 and the value For seekable streams, this is a number between 0 (inclusive) and the
returned by op_link_count(). value returned by op_link_count() (exclusive).
For unseekable streams, this value starts at 0 and increments by one For unseekable streams, this value starts at 0 and increments by one
each time a new link is encountered (even though op_link_count() each time a new link is encountered (even though op_link_count()
always returns 1). always returns 1).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment