summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Update release version and date on the reference docs.Ralph Giles2014-05-2767-134/+134
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@19150 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Update copyright year.Ralph Giles2014-05-2763-63/+63
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@19149 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Update the doc versions for the 1.3.1 release.Tim Terriberry2013-05-1467-197/+197
| | | | | | | | | Done with `make -C doc/libogg update-doc-version`. Patch contributed by Ron Lee. git-svn-id: http://svn.xiph.org/trunk/ogg@18944 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Add a makefile target to update the doc versionsTim Terriberry2013-05-141-0/+13
| | | | | | | | | | | | This isn't automatic. It does need to be invoked explicitly, after the package version is changed in configure.in, immediately before release, but that beats updating all of those files by hand for each release. Patch contributed by Ron Lee. git-svn-id: http://svn.xiph.org/trunk/ogg@18941 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Minor documentation fixes.Tim Terriberry2013-05-065-5/+5
| | | | | | | | Fixes some broken links that were pointing to the wrong place, and some formatting errors. git-svn-id: http://svn.xiph.org/trunk/ogg@18935 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Subject: [PATCH 3/3] Respect the configure --docdir overrideTim Terriberry2013-05-062-7/+3
| | | | | | | | | | | | Thanks to RedDwarf, lilrc, and mgorny for pointing it out and suggesting patches. Patch contributed by Ron Lee. Closes ticket:1758 git-svn-id: http://svn.xiph.org/trunk/ogg@18934 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Typo fix.Tim Terriberry2013-05-061-1/+1
| | | | | | | Patch contributed by Ron Lee. git-svn-id: http://svn.xiph.org/trunk/ogg@18933 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Fix broken links in the installed docs.Tim Terriberry2013-05-062-8/+9
| | | | | | | | | | | Adds some files that weren't being installed at all. Installs the libogg docs with the same relative path that they have in the source, which is where the top level index link expects them to be. Patch contributed by Ron Lee. git-svn-id: http://svn.xiph.org/trunk/ogg@18932 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Close the anchor added in r17179.Ralph Giles2012-06-211-1/+1
| | | | | | | This keeps the header description from being rendered blue. git-svn-id: http://svn.xiph.org/trunk/ogg@18422 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Fix link to ogg_stream_state.Tim Terriberry2012-03-011-1/+1
| | | | | | | Thanks to David Richards for the report. git-svn-id: http://svn.xiph.org/trunk/ogg@18217 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Bump version number and dates for release.Ralph Giles2011-08-0467-197/+197
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@18054 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Improve documentation of ogg_stream_flush_fill and related calls.Ralph Giles2011-08-045-7/+18
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@18053 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Add ogg_stream_flush_fill to compliment ogg_stream_pageout_fill because ↵Gregory Maxwell2011-08-011-0/+69
| | | | | | ogg_stream_flush will produce multiple pages when >4096 bytes and >4 packets are available. git-svn-id: http://svn.xiph.org/trunk/ogg@18044 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Fix ogg_stream_pageout_fill documentation bug pointed out by David Richards.Gregory Maxwell2010-12-011-1/+1
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@17693 0101bb08-14d6-0310-b084-bc0e0c8e3800
* add ogg_stream_pageout_fill to libogg docsMonty2010-10-2967-132/+225
| | | | | | | | | Update release version on libogg docs git-svn-id: http://svn.xiph.org/trunk/ogg@17580 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Fix another cut-and-paste error in the documentation.Ralph Giles2010-10-091-1/+1
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@17498 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Explicitly document what ogg_packet_clear() does.Ralph Giles2010-10-091-2/+4
| | | | | | | | | | | | | The ogg_packet structure is public, and contains no 'internal' data, except in that decoding functions allocate and own the returned buffer. When a client creates packets to pass into the encoding functions it is instead the client which owns the buffer. Nevertheless, ogg_packet_clear() can be useful if the client is using a simple allocation strategy. I wanted to be clear that it was appropriate to use this call for such packets. git-svn-id: http://svn.xiph.org/trunk/ogg@17497 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Fix a cut-and-paste error in the documentation.Ralph Giles2010-10-091-1/+1
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@17496 0101bb08-14d6-0310-b084-bc0e0c8e3800
* add an anchorMonty2010-04-271-0/+1
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@17179 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Doc tweaks; clarify/make more consistent the Index reasoning.Monty2010-04-262-18/+25
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@17175 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Add another diagram (elementary multiplexing)Monty2010-04-063-37/+699
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@17135 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Greg asserts interruptMonty2010-03-301-4/+1
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@17101 0101bb08-14d6-0310-b084-bc0e0c8e3800
* More doccing, commit SVG filesMonty2010-03-304-23/+2118
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@17100 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Removed the non-normative comment about 4kB pages. The observation of ↵Gregory Maxwell2010-03-301-2/+3
| | | | | | typical behavior isn't especially useful here, and at least one person has interpreted the comment to imply some kind of limit. Replace the text with something less likely to be construed as a limit. git-svn-id: http://svn.xiph.org/trunk/ogg@17099 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Stupid error in figure...Monty2010-03-281-0/+0
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@17096 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Add two new figures illustrating packets, pages, logical bitstreams and Monty2010-03-283-2/+67
| | | | | | | | physical bitstreams. git-svn-id: http://svn.xiph.org/trunk/ogg@17095 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Update dates on libogg documentationMonty2010-03-2565-195/+195
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@17034 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Update CHANGES fileMonty2010-03-251-13/+10
| | | | | | | | | Correct one last misleading caption in the stream documentation, pending the more complete examples rewrite langing post 1.2.0 git-svn-id: http://svn.xiph.org/trunk/ogg@17033 0101bb08-14d6-0310-b084-bc0e0c8e3800
* clarify an analogy in demultiplexingMonty2010-03-202-2/+2
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@16992 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Substantial expansion of Ogg container overview document; still requires ↵Monty2010-03-201-116/+378
| | | | | | | | | | filling in of several references by not-yet-present examples. git-svn-id: http://svn.xiph.org/trunk/ogg@16991 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Update Ogg document titles towards doc update.Monty2010-03-191-3/+3
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@16988 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Fix copy/paste error.Tim Terriberry2010-02-151-1/+1
| | | | | | | Thanks to Chris Pearce for the report. git-svn-id: http://svn.xiph.org/trunk/ogg@16901 0101bb08-14d6-0310-b084-bc0e0c8e3800
* framing.html: minor spelling error correction from HoldenC.Gregory Maxwell2010-02-111-1/+1
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@16893 0101bb08-14d6-0310-b084-bc0e0c8e3800
* ogg_stream_pageout.html: Comment on calling pageout in a loop based on ↵Gregory Maxwell2009-11-291-1/+2
| | | | | | feedback from Diablo-D3 in IRC git-svn-id: http://svn.xiph.org/trunk/ogg@16743 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Correct return value documentation for two calls. Ralph Giles2009-10-052-2/+2
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@16616 0101bb08-14d6-0310-b084-bc0e0c8e3800
* correct a typo which referred to os instead of opMonty2009-07-151-1/+1
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@16289 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Commit doc updates relating to async error interfaceMonty2009-05-2723-179/+175
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@16049 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Update copyright on modified pages, render name and versioning consistent.Monty2009-05-2055-163/+163
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@16018 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Update documentation to reflect new API calls, and extended error return ↵Monty2009-05-2010-5/+242
| | | | | | behavior. git-svn-id: http://svn.xiph.org/trunk/ogg@16017 0101bb08-14d6-0310-b084-bc0e0c8e3800
* fix implication that op is updated when -1 is returned.oggk2009-04-041-1/+1
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@15906 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Ogg video streams no longer require future tense.Ralph Giles2009-01-221-4/+4
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@15628 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Monotonicity of time ordering cannot be 'strict' as this equal times are Ralph Giles2008-12-301-2/+2
| | | | | | | possible. Use the more obvious term 'non-decreasing' for clarity. git-svn-id: http://svn.xiph.org/trunk/ogg@15595 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Clarify that muxing orders the pages in strict timestamp order among all Ralph Giles2008-12-301-3/+3
| | | | | | | streams, not just within each logical stream. git-svn-id: http://svn.xiph.org/trunk/ogg@15594 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Add RFC 5334 and skeleton.html to Makefile. Mention CHANGES in debian rules ↵ivo2008-09-101-1/+1
| | | | | | file. git-svn-id: http://svn.xiph.org/trunk/ogg@15288 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Add RFC5334 and link to it.ivo2008-09-082-1/+788
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@15269 0101bb08-14d6-0310-b084-bc0e0c8e3800
* And speaking of missing links...ivo2008-08-311-0/+1
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@15231 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Clarify that the _destroy() methods call _ogg_free() on their argumentsRalph Giles2008-04-282-2/+15
| | | | | | | even though there's no explicit constructor. git-svn-id: http://svn.xiph.org/trunk/ogg@14810 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Skeleton documentation page. Right now it's just a static copy from the wiki.ivo2008-02-221-0/+222
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@14535 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Document what oggpack_bytes() returns for read-initialized streams.Ralph Giles2008-02-141-4/+9
| | | | git-svn-id: http://svn.xiph.org/trunk/ogg@14505 0101bb08-14d6-0310-b084-bc0e0c8e3800
* Remove "Ogg Vorbis" project references and the obsolete contact email Ralph Giles2008-01-0462-63/+63
| | | | | | | from the libogg documentation. git-svn-id: http://svn.xiph.org/trunk/ogg@14365 0101bb08-14d6-0310-b084-bc0e0c8e3800