Add rough reference documentation for the main encoding calls.
authorRalph Giles <giles@xiph.org>
Sat, 19 Dec 2009 07:59:52 +0000 (07:59 +0000)
committerRalph Giles <giles@xiph.org>
Sat, 19 Dec 2009 07:59:52 +0000 (07:59 +0000)
commit1028f159c2910a878687481d966224e8b3a2a974
tree5388fe307e1990a6b8e1e035ca537a61901cef8f
parentcd6c4cf73b26aabc028afc090b900da0d951a072
Add rough reference documentation for the main encoding calls.

These are a bit rough in that the main calls are declared in codec.h,
and not vorbisenc.h as one might expect for the encoder. Nevertheless
I felt this was helpful to those trying to use the encoder since there
is no 'Programming with libvorbis' documenation at all.

The error return values listed don't entirely match what the code will
actually provide, but they're all good ones to check for anyway.

Note of the new pages have hyperlinked function or structure names.

svn path=/trunk/vorbis/; revision=16756
doc/vorbisenc/reference.html
doc/vorbisenc/vorbis_analysis.html [new file with mode: 0644]
doc/vorbisenc/vorbis_analysis_blockout.html [new file with mode: 0644]
doc/vorbisenc/vorbis_analysis_buffer.html [new file with mode: 0644]
doc/vorbisenc/vorbis_analysis_headerout.html [new file with mode: 0644]
doc/vorbisenc/vorbis_analysis_init.html [new file with mode: 0644]
doc/vorbisenc/vorbis_analysis_wrote.html [new file with mode: 0644]
doc/vorbisenc/vorbis_bitrate_addblock.html [new file with mode: 0644]
doc/vorbisenc/vorbis_bitrate_flushpacket.html [new file with mode: 0644]
doc/vorbisenc/vorbis_block_init.html [new file with mode: 0644]