summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Update documentation version for 1.3.5 release.v1.3.5Ralph Giles2021-06-0367-201/+201
| | | | Result of running `make -C doc/libogg update-doc-version`.
* Fix link in ogg_stream_clear documentation.Ralph Giles2020-05-251-1/+1
| | | | | The link pointed to the wrong structure documentation. Looks like a cut-and-paste error.
* Fix link in ogg_stream_init documentationthp-hatch2020-05-251-1/+1
| | | | Signed-off-by: Ralph Giles <giles@thaumas.net>
* doc: fix typoTristan Matthews2019-10-291-1/+1
|
* Update documentation version and release date for v1.3.4.v1.3.4Ralph Giles2019-08-3067-201/+201
| | | | Result of running make -C doc/libogg update-doc-version.
* Update release checklist.Ralph Giles2019-08-301-0/+1
| | | | | Describe how to update documentation versioning. No need for sed one-liners each time.
* Improve ogg_stream_state documentation formatting.Ralph Giles2019-08-131-8/+9
| | | | | Copy the struct definition from ogg.h which has better comment alignment.
* Fix ogg_stream_state documentation.Ralph Giles2019-08-131-1/+1
| | | | | | | The pageno is declared `long` in the header, not `int`, although it's a 32-bit value in the page header. Thanks to Spencer Russell for reporting the issue.
* Fix documentation typo.Ralph Giles2019-07-312-2/+2
| | | | | Update cut-and-paste description of the reset functions to reference resetting instead of clearing.
* Remove trailing whitespace from the api documentation.Ralph Giles2018-10-0921-63/+63
|
* Misc. typosluz.paz2018-10-097-8/+8
| | | | | | Found via `codespell -q 3` Signed-off-by: Erik de Castro Lopo <erikd@mega-nerd.com>
* Add a release checklist.Ralph Giles2017-11-071-0/+28
|
* Update version and release date on the documentation.Ralph Giles2017-11-0767-201/+201
| | | | | | | | Bump the API documentation page footer for the latest release. I missed this before making the 1.3.3 release, changing it now and including this version on the website is less confusing, I think.
* Fix a documentation typo.Ralph Giles2015-11-091-1/+1
|
* Update release version and date on the reference docs.v1.3.2Ralph Giles2014-05-2767-134/+134
| | | | svn path=/trunk/ogg/; revision=19150
* Update copyright year.Ralph Giles2014-05-2763-63/+63
| | | | svn path=/trunk/ogg/; revision=19149
* Update the doc versions for the 1.3.1 release.v1.3.1Tim Terriberry2013-05-1467-197/+197
| | | | | | | | Done with `make -C doc/libogg update-doc-version`. Patch contributed by Ron Lee. svn path=/trunk/ogg/; revision=18944
* 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. svn path=/trunk/ogg/; revision=18941
* Minor documentation fixes.Tim Terriberry2013-05-065-5/+5
| | | | | | | Fixes some broken links that were pointing to the wrong place, and some formatting errors. svn path=/trunk/ogg/; revision=18935
* 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 svn path=/trunk/ogg/; revision=18934
* Typo fix.Tim Terriberry2013-05-061-1/+1
| | | | | | Patch contributed by Ron Lee. svn path=/trunk/ogg/; revision=18933
* 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. svn path=/trunk/ogg/; revision=18932
* Close the anchor added in r17179.Ralph Giles2012-06-211-1/+1
| | | | | | This keeps the header description from being rendered blue. svn path=/trunk/ogg/; revision=18422
* Fix link to ogg_stream_state.Tim Terriberry2012-03-011-1/+1
| | | | | | Thanks to David Richards for the report. svn path=/trunk/ogg/; revision=18217
* Bump version number and dates for release.v1.3.0Ralph Giles2011-08-0467-197/+197
| | | | svn path=/trunk/ogg/; revision=18054
* Improve documentation of ogg_stream_flush_fill and related calls.Ralph Giles2011-08-045-7/+18
| | | | svn path=/trunk/ogg/; revision=18053
* 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. svn path=/trunk/ogg/; revision=18044
* Fix ogg_stream_pageout_fill documentation bug pointed out by David Richards.Gregory Maxwell2010-12-011-1/+1
| | | | svn path=/trunk/ogg/; revision=17693
* add ogg_stream_pageout_fill to libogg docsMonty2010-10-2967-132/+225
| | | | | | | | Update release version on libogg docs svn path=/trunk/ogg/; revision=17580
* Fix another cut-and-paste error in the documentation.Ralph Giles2010-10-091-1/+1
| | | | svn path=/trunk/ogg/; revision=17498
* 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. svn path=/trunk/ogg/; revision=17497
* Fix a cut-and-paste error in the documentation.Ralph Giles2010-10-091-1/+1
| | | | svn path=/trunk/ogg/; revision=17496
* add an anchorMonty2010-04-271-0/+1
| | | | svn path=/trunk/ogg/; revision=17179
* Doc tweaks; clarify/make more consistent the Index reasoning.Monty2010-04-262-18/+25
| | | | svn path=/trunk/ogg/; revision=17175
* Add another diagram (elementary multiplexing)Monty2010-04-063-37/+699
| | | | svn path=/trunk/ogg/; revision=17135
* Greg asserts interruptMonty2010-03-301-4/+1
| | | | svn path=/trunk/ogg/; revision=17101
* More doccing, commit SVG filesMonty2010-03-304-23/+2118
| | | | svn path=/trunk/ogg/; revision=17100
* 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. svn path=/trunk/ogg/; revision=17099
* Stupid error in figure...Monty2010-03-281-0/+0
| | | | svn path=/trunk/ogg/; revision=17096
* Add two new figures illustrating packets, pages, logical bitstreams and Monty2010-03-283-2/+67
| | | | | | | physical bitstreams. svn path=/trunk/ogg/; revision=17095
* Update dates on libogg documentationMonty2010-03-2565-195/+195
| | | | svn path=/trunk/ogg/; revision=17034
* 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 svn path=/trunk/ogg/; revision=17033
* clarify an analogy in demultiplexingMonty2010-03-202-2/+2
| | | | svn path=/trunk/ogg/; revision=16992
* Substantial expansion of Ogg container overview document; still requires ↵Monty2010-03-201-116/+378
| | | | | | | | | filling in of several references by not-yet-present examples. svn path=/trunk/ogg/; revision=16991
* Update Ogg document titles towards doc update.Monty2010-03-191-3/+3
| | | | svn path=/trunk/ogg/; revision=16988
* Fix copy/paste error.Tim Terriberry2010-02-151-1/+1
| | | | | | Thanks to Chris Pearce for the report. svn path=/trunk/ogg/; revision=16901
* framing.html: minor spelling error correction from HoldenC.Gregory Maxwell2010-02-111-1/+1
| | | | svn path=/trunk/ogg/; revision=16893
* 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 svn path=/trunk/ogg/; revision=16743
* Correct return value documentation for two calls. Ralph Giles2009-10-052-2/+2
| | | | svn path=/trunk/ogg/; revision=16616
* correct a typo which referred to os instead of opMonty2009-07-151-1/+1
| | | | svn path=/trunk/ogg/; revision=16289
View Lorry Controller Status