[xiph-commits] r17581 - in trunk/vorbis: . doc doc/vorbisenc doc/vorbisfile
xiphmont at svn.xiph.org
xiphmont at svn.xiph.org
Mon Nov 1 11:47:53 PDT 2010
Author: xiphmont
Date: 2010-11-01 11:47:53 -0700 (Mon, 01 Nov 2010)
New Revision: 17581
Modified:
trunk/vorbis/configure.ac
trunk/vorbis/doc/Makefile.am
trunk/vorbis/doc/index.html
trunk/vorbis/doc/vorbisenc/Makefile.am
trunk/vorbis/doc/vorbisenc/examples.html
trunk/vorbis/doc/vorbisenc/reference.html
trunk/vorbis/doc/vorbisenc/vorbis_encode_ctl.html
trunk/vorbis/doc/vorbisenc/vorbis_encode_init.html
trunk/vorbis/doc/vorbisenc/vorbis_encode_init_vbr.html
trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_init.html
trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_managed.html
trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_vbr.html
trunk/vorbis/doc/vorbisfile/Makefile.am
trunk/vorbis/doc/vorbisfile/chainingexample.html
trunk/vorbis/doc/vorbisfile/datastructures.html
trunk/vorbis/doc/vorbisfile/fileinfo.html
trunk/vorbis/doc/vorbisfile/initialization.html
trunk/vorbis/doc/vorbisfile/ov_comment.html
trunk/vorbis/doc/vorbisfile/ov_info.html
trunk/vorbis/doc/vorbisfile/reference.html
Log:
Commit libvorbis documentation patch from John Stumpo; adds complete
docs to libvorbis, moves a few pages from the vorbisfile and
libvorbisenc docs into the new libvorbis doc tree.
Modified: trunk/vorbis/configure.ac
===================================================================
--- trunk/vorbis/configure.ac 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/configure.ac 2010-11-01 18:47:53 UTC (rev 17581)
@@ -281,7 +281,7 @@
lib/books/coupled/Makefile
lib/books/uncoupled/Makefile
lib/books/floor/Makefile
-doc/Makefile doc/vorbisfile/Makefile doc/vorbisenc/Makefile
+doc/Makefile doc/vorbisfile/Makefile doc/vorbisenc/Makefile doc/libvorbis/Makefile
doc/Doxyfile
include/Makefile include/vorbis/Makefile
examples/Makefile
Modified: trunk/vorbis/doc/Makefile.am
===================================================================
--- trunk/vorbis/doc/Makefile.am 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/Makefile.am 2010-11-01 18:47:53 UTC (rev 17581)
@@ -1,6 +1,6 @@
## Process this with automake to create Makefile.in
-SUBDIRS = vorbisfile vorbisenc
+SUBDIRS = libvorbis vorbisfile vorbisenc
docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)
Modified: trunk/vorbis/doc/index.html
===================================================================
--- trunk/vorbis/doc/index.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/index.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -91,7 +91,7 @@
<h2>Ogg Vorbis programming documents</h2>
<ul>
-<li>Programming with libvorbis</li>
+<li><a href="libvorbis/index.html">Programming with libvorbis</a></li>
<li><a href="vorbisfile/index.html">Programming with vorbisfile</a></li>
<li><a href="vorbisenc/index.html">Programming with vorbisenc</a></li>
</ul>
Modified: trunk/vorbis/doc/vorbisenc/Makefile.am
===================================================================
--- trunk/vorbis/doc/vorbisenc/Makefile.am 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisenc/Makefile.am 2010-11-01 18:47:53 UTC (rev 17581)
@@ -2,10 +2,10 @@
docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)/vorbisenc
-doc_DATA = changes.html examples.html index.html ov_ectl_ratemanage2_arg.html \
- ov_ectl_ratemanage_arg.html overview.html reference.html style.css\
+doc_DATA = changes.html examples.html index.html ovectl_ratemanage2_arg.html \
+ ovectl_ratemanage_arg.html overview.html reference.html style.css\
vorbis_encode_ctl.html vorbis_encode_init.html vorbis_encode_setup_init.html \
- vorbis_encode_setup_managed.html vorbis_encode_setup_vbr.html vorbis_info.html \
+ vorbis_encode_setup_managed.html vorbis_encode_setup_vbr.html \
vorbis_encode_init_vbr.html
EXTRA_DIST = $(doc_DATA)
Modified: trunk/vorbis/doc/vorbisenc/examples.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/examples.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisenc/examples.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -21,7 +21,7 @@
highest quality for a the bits used.
<p>The following code examples prepare a
-<a href="vorbis_info.html">vorbis_info</a> structure for encoding
+<a href="../libvorbis/vorbis_info.html">vorbis_info</a> structure for encoding
use with libvorbis.<p>
<h2>Example: encoding using a VBR quality mode</h2>
Modified: trunk/vorbis/doc/vorbisenc/reference.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/reference.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisenc/reference.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -18,9 +18,9 @@
<h2>Data Structures</h2>
<p>
-<a href="vorbis_info.html">vorbis_info</a><br>
-<a href="ov_ectl_ratemanage_arg.html">ov_ectl_ratemanage_arg</a><br>
-<a href="ov_ectl_ratemanage2_arg.html">ov_ectl_ratemanage2_arg</a><br>
+<a href="../libvorbis/vorbis_info.html">vorbis_info</a> (from <a href="../libvorbis/index.html">libvorbis</a>)<br>
+<a href="ovectl_ratemanage_arg.html">ovectl_ratemanage_arg</a><br>
+<a href="ovectl_ratemanage2_arg.html">ovectl_ratemanage2_arg</a><br>
</p>
<h2>Encoder Setup</h2>
@@ -34,28 +34,8 @@
<a href="vorbis_encode_setup_vbr.html">vorbis_encode_setup_vbr()</a><br>
</p>
-<h2>Encoding</h2>
+<p>The actual encoding is done using the <a href="../libvorbis/index.html">libvorbis API</a>.</p>
-<p>
-<a href="vorbis_analysis_init.html">vorbis_analysis_init()</a><br>
-<a href="vorbis_block_init.html">vorbis_block_init()</a><br>
-</p>
-
-<p>
-<a href="vorbis_analysis_headerout.html">vorbis_analysis_headerout()</a><br>
-</p>
-
-<p>
-<a href="vorbis_analysis_buffer.html">vorbis_analysis_buffer()</a><br>
-<a href="vorbis_analysis_wrote.html">vorbis_analysis_wrote()</a><br>
-<a href="vorbis_analysis_blockout.html">vorbis_analysis_blockout()</a><br>
-</p>
-<p>
-<a href="vorbis_analysis.html">vorbis_analysis()</a><br>
-<a href="vorbis_bitrate_addblock.html">vorbis_bitrate_addblock()</a><br>
-<a href="vorbis_bitrate_flushpacket.html">vorbis_bitrate_flushpacket()</a><br>
-</p>
-
<br>
<br>
<hr noshade>
Modified: trunk/vorbis/doc/vorbisenc/vorbis_encode_ctl.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/vorbis_encode_ctl.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisenc/vorbis_encode_ctl.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -46,7 +46,7 @@
<h3>Parameters</h3>
<dl>
<dt><i>vi</i></dt>
-<dd>Pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd><p>
+<dd>Pointer to an initialized <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct.</dd><p>
<dt><i>request</i></dt>
<dd>Specifies the desired action; possible request fields are detailed below.</dd><p>
<dt><i>arg</i></dt>
Modified: trunk/vorbis/doc/vorbisenc/vorbis_encode_init.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/vorbis_encode_init.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisenc/vorbis_encode_init.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -18,7 +18,7 @@
<p><i>declared in "vorbis/vorbisenc.h";</i></p>
<p>This is the primary function within libvorbisenc for setting up managed bitrate modes.
-<p>Before this function is called, the <a href="vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.
+<p>Before this function is called, the <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.
<p>The max_bitrate, nominal_bitrate, and min_bitrate settings are used to set constraints for the encoded file. This function uses these settings to select the appropriate encoding mode and set it up.
<p>
<br><br>
@@ -26,7 +26,7 @@
<tr bgcolor=#cccccc>
<td>
<pre><b>
-extern int vorbis_encode_init(<a href="vorbis_info.html">vorbis_info</a> *vi,
+extern int vorbis_encode_init(<a href="../libvorbis/vorbis_info.html">vorbis_info</a> *vi,
long channels,
long rate,
@@ -42,7 +42,7 @@
<h3>Parameters</h3>
<dl>
<dt><i>vi</i></dt>
-<dd>Pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
+<dd>Pointer to an initialized <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct.</dd>
<dt><i>channels</i></dt>
<dd>The number of channels to be encoded.</dd>
<dt><i>rate</i></dt>
Modified: trunk/vorbis/doc/vorbisenc/vorbis_encode_init_vbr.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/vorbis_encode_init_vbr.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisenc/vorbis_encode_init_vbr.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -18,14 +18,14 @@
<p><i>declared in "vorbis/vorbisenc.h";</i></p>
<p>This is the primary function within libvorbisenc for setting up variable bitrate ("quality" based) modes.
-<p>Before this function is called, the <a href="vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.
+<p>Before this function is called, the <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.
<p>
<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
<td>
<pre><b>
-extern int vorbis_encode_init_vbr(<a href="vorbis_info.html">vorbis_info</a> *vi,
+extern int vorbis_encode_init_vbr(<a href="../libvorbis/vorbis_info.html">vorbis_info</a> *vi,
long channels,
long rate,
@@ -39,7 +39,7 @@
<h3>Parameters</h3>
<dl>
<dt><i>vi</i></dt>
-<dd>Pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
+<dd>Pointer to an initialized <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct.</dd>
<dt><i>channels</i></dt>
<dd>The number of channels to be encoded.</dd>
<dt><i>rate</i></dt>
Modified: trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_init.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_init.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_init.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -20,7 +20,7 @@
<p>This function performs the last stage of three-step encoding setup, as described in the API overview under <a href="overview.html#BBR">managed bitrate modes</a>.
<p>Before this function is called, the <a
-href="vorbis_info.html">vorbis_info</a> struct should be initialized
+href="../libvorbis/vorbis_info.html">vorbis_info</a> struct should be initialized
by using vorbis_info_init() from the libvorbis API, one of <a
href="vorbis_encode_setup_managed.html">vorbis_encode_setup_managed()</a>
or <a
@@ -38,7 +38,7 @@
<tr bgcolor=#cccccc>
<td>
<pre><b>
-extern int vorbis_encode_setup_init(<a href="vorbis_info.html">vorbis_info</a> *vi);
+extern int vorbis_encode_setup_init(<a href="../libvorbis/vorbis_info.html">vorbis_info</a> *vi);
</b></pre>
</td>
@@ -48,7 +48,7 @@
<h3>Parameters</h3>
<dl>
<dt><i>vi</i></dt>
-<dd>Pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
+<dd>Pointer to an initialized <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct.</dd>
</dl>
Modified: trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_managed.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_managed.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_managed.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -27,7 +27,7 @@
complete the setup process.
<p>Before this function is called, the <a
-href="vorbis_info.html">vorbis_info</a> struct should be initialized
+href="../libvorbis/vorbis_info.html">vorbis_info</a> struct should be initialized
by using vorbis_info_init() from the libvorbis API. After encoding,
vorbis_info_clear should be called.
@@ -40,7 +40,7 @@
<tr bgcolor=#cccccc>
<td>
<pre><b>
-extern int vorbis_encode_init(<a href="vorbis_info.html">vorbis_info</a> *vi,
+extern int vorbis_encode_init(<a href="../libvorbis/vorbis_info.html">vorbis_info</a> *vi,
long channels,
long rate,
@@ -56,7 +56,7 @@
<h3>Parameters</h3>
<dl>
<dt><i>vi</i></dt>
-<dd>Pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
+<dd>Pointer to an initialized <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct.</dd>
<dt><i>channels</i></dt>
<dd>The number of channels to be encoded.</dd>
<dt><i>rate</i></dt>
Modified: trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_vbr.html
===================================================================
--- trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_vbr.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisenc/vorbis_encode_setup_vbr.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -27,14 +27,14 @@
href="vorbis_encode_setup_init.html">vorbis_encode_setup_init()</a> to
complete the setup process.
-<p>Before this function is called, the <a href="vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.
+<p>Before this function is called, the <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.
<p>
<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
<td>
<pre><b>
-extern int vorbis_encode_init_vbr(<a href="vorbis_info.html">vorbis_info</a> *vi,
+extern int vorbis_encode_init_vbr(<a href="../libvorbis/vorbis_info.html">vorbis_info</a> *vi,
long channels,
long rate,
@@ -48,7 +48,7 @@
<h3>Parameters</h3>
<dl>
<dt><i>vi</i></dt>
-<dd>Pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
+<dd>Pointer to an initialized <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct.</dd>
<dt><i>channels</i></dt>
<dd>The number of channels to be encoded.</dd>
<dt><i>rate</i></dt>
Modified: trunk/vorbis/doc/vorbisfile/Makefile.am
===================================================================
--- trunk/vorbis/doc/vorbisfile/Makefile.am 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisfile/Makefile.am 2010-11-01 18:47:53 UTC (rev 17581)
@@ -17,9 +17,9 @@
ov_streams.html ov_test.html ov_test_callbacks.html ov_test_open.html\
ov_time_seek.html ov_time_seek_lap.html ov_time_seek_page.html\
ov_time_seek_page_lap.html ov_time_tell.html ov_time_total.html\
- overview.html reference.html return.html seekexample.html seeking.html\
+ overview.html reference.html seekexample.html seeking.html\
seeking_example_c.html seeking_test_c.html seekingexample.html\
- style.css threads.html vorbis_comment.html vorbis_info.html\
+ style.css threads.html\
vorbisfile_example_c.html
EXTRA_DIST = $(doc_DATA)
Modified: trunk/vorbis/doc/vorbisfile/chainingexample.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/chainingexample.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisfile/chainingexample.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -116,7 +116,7 @@
<p>Now we're going to iterate through each logical bitstream and print information about that bitstream.
-<p>We use <a href="ov_info.html">ov_info</a> to pull out the <a href="vorbis_info.html">vorbis_info</a> struct for each logical bitstream. This struct contains bitstream-specific info.
+<p>We use <a href="ov_info.html">ov_info</a> to pull out the <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct for each logical bitstream. This struct contains bitstream-specific info.
<p><a href="ov_serialnumber.html">ov_serialnumber</a> retrieves the unique serial number for the logical bistream. <a href="ov_raw_total.html">ov_raw_total</a> gives the total compressed bytes for the logical bitstream, and <a href="ov_time_total.html">ov_time_total</a> gives the total time in the logical bitstream.
Modified: trunk/vorbis/doc/vorbisfile/datastructures.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/datastructures.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisfile/datastructures.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -30,12 +30,12 @@
a pointer to the physical file or bitstream and various information about that bitstream.</td>
</tr>
<tr valign=top>
-<td><a href="vorbis_comment.html">vorbis_comment</a></td>
+<td><a href="../libvorbis/vorbis_comment.html">vorbis_comment</a></td>
<td>This structure contains the file comments. It contains
a pointer to unlimited user comments, information about the number of comments, and a vendor description.</td>
</tr>
<tr valign=top>
-<td><a href="vorbis_info.html">vorbis_info</a></td>
+<td><a href="../libvorbis/vorbis_info.html">vorbis_info</a></td>
<td>This structure contains encoder-related information about the bitstream. It includes encoder info, channel info, and bitrate limits.</td>
</tr>
<tr valign=top>
Modified: trunk/vorbis/doc/vorbisfile/fileinfo.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/fileinfo.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisfile/fileinfo.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -70,11 +70,11 @@
</tr>
<tr valign=top>
<td><a href="ov_info.html">ov_info</a></td>
- <td>Returns the <a href="vorbis_info.html">vorbis_info</a> struct for a specific bitstream section.</td>
+ <td>Returns the <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct for a specific bitstream section.</td>
</tr>
<tr valign=top>
<td><a href="ov_comment.html">ov_comment</a></td>
- <td>Returns attached <a href="vorbis_comment.html">comments</a> for the current bitstream.</td>
+ <td>Returns attached <a href="../libvorbis/vorbis_comment.html">comments</a> for the current bitstream.</td>
</tr>
</table>
Modified: trunk/vorbis/doc/vorbisfile/initialization.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/initialization.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisfile/initialization.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -19,7 +19,7 @@
The simplest possible case is to use <a
href="ov_fopen.html">ov_fopen()</a> to open the file for access, check
it for Vorbis content, and prepare it for playback. A successful <a
-href="return.html">return code</a> from <a
+href="../libvorbis/return.html">return code</a> from <a
href="ov_fopen.html">ov_fopen()</a> indicates the file is ready for use.
Once the file is no longer needed, <a
href="ov_clear.html">ov_clear()</a> is used to close the file and
@@ -69,7 +69,7 @@
is an Ogg Vorbis file or not. A successful return indicates that the
file appears to be an Ogg Vorbis file, but the <a
href="OggVorbis_File.html">OggVorbis_File</a> struct is not yet fully
-initialized for actual decoding. After a <a href="return.html">successful return</a>, the file
+initialized for actual decoding. After a <a href="../libvorbis/return.html">successful return</a>, the file
may be closed using <a href="ov_clear.html">ov_clear()</a> or fully
opened for decoding using <a
href="ov_test_open.html">ov_test_open()</a>.<p> This call is intended to
Modified: trunk/vorbis/doc/vorbisfile/ov_comment.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/ov_comment.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisfile/ov_comment.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -18,7 +18,7 @@
<p><i>declared in "vorbis/vorbisfile.h";</i></p>
-<p>Returns a pointer to the <a href="vorbis_comment.html">vorbis_comment</a> struct for the specified bitstream. For nonseekable streams, returns the struct for the current bitstream.
+<p>Returns a pointer to the <a href="../libvorbis/vorbis_comment.html">vorbis_comment</a> struct for the specified bitstream. For nonseekable streams, returns the struct for the current bitstream.
<p>
<br><br>
@@ -38,7 +38,7 @@
<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
functions.</dd>
<dt><i>i</i></dt>
-<dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="vorbis_comment.html">vorbis_comment</a> struct for the current bitstream, this parameter should be set to -1.</dd>
+<dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="../libvorbis/vorbis_comment.html">vorbis_comment</a> struct for the current bitstream, this parameter should be set to -1.</dd>
</dl>
Modified: trunk/vorbis/doc/vorbisfile/ov_info.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/ov_info.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisfile/ov_info.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -17,7 +17,7 @@
<p><i>declared in "vorbis/vorbisfile.h";</i></p>
-<p>Returns the <a href="vorbis_info.html">vorbis_info</a> struct for the specified bitstream. For nonseekable files, always returns the current vorbis_info struct.
+<p>Returns the <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct for the specified bitstream. For nonseekable files, always returns the current vorbis_info struct.
<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
@@ -36,7 +36,7 @@
<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
functions. </dd>
<dt><i>i</i></dt>
-<dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="vorbis_info.html">vorbis_info</a> struct for the current bitstream, this parameter should be set to -1.</dd>
+<dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct for the current bitstream, this parameter should be set to -1.</dd>
</dl>
Modified: trunk/vorbis/doc/vorbisfile/reference.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/reference.html 2010-10-29 20:46:42 UTC (rev 17580)
+++ trunk/vorbis/doc/vorbisfile/reference.html 2010-11-01 18:47:53 UTC (rev 17581)
@@ -18,10 +18,12 @@
<p>
<b>Data Structures</b><br>
<a href="OggVorbis_File.html">OggVorbis_File</a><br>
-<a href="vorbis_comment.html">vorbis_comment</a><br>
-<a href="vorbis_info.html">vorbis_info</a><br>
<a href="ov_callbacks.html">ov_callbacks</a><br>
<br>
+<b>Data Structures from <a href="../libvorbis/index.html">libvorbis</a></b><br>
+<a href="../libvorbis/vorbis_comment.html">vorbis_comment</a><br>
+<a href="../libvorbis/vorbis_info.html">vorbis_info</a><br>
+<br>
<b>Setup/Teardown</b><br>
<a href="ov_fopen.html">ov_fopen()</a><br>
<a href="ov_open.html">ov_open()</a><br>
@@ -64,7 +66,7 @@
<a href="ov_info.html">ov_info()</a><br>
<a href="ov_comment.html">ov_comment()</a><br>
<br>
-<b><a href="return.html">Return Codes</a></b><br>
+<b><a href="../libvorbis/return.html">Return Codes</a> (from <a href="../libvorbis/index.html">libvorbis</a>)</b><br>
<br><br>
More information about the commits
mailing list