Remove obsolete oggpack_*_huff() functions from API documenation.

git-svn-id: http://svn.xiph.org/trunk/ogg@3686 0101bb08-14d6-0310-b084-bc0e0c8e3800
author: Ralph Giles <giles@xiph.org> 2002-07-19 11:03:39 +0000
committer: Ralph Giles <giles@xiph.org> 2002-07-19 11:03:39 +0000
commit: 6ff3cbbe36a23ba7e648a23df40b86ace7ee711d (patch)
tree: f40086f1919dd4717db37fa6ed8124ec74b0759a /doc
parent: 075adf68d5ce9018c6a52c97b224bfdef0cac4d5 (diff)
download: ogg-6ff3cbbe36a23ba7e648a23df40b86ace7ee711d.tar.gz
7 files changed, 4 insertions, 151 deletions
diff --git a/doc/ogg/Makefile.am b/doc/ogg/Makefile.am
index e27e33a..5ebed4f 100644
--- a/doc/ogg/Makefile.am
+++ b/doc/ogg/Makefile.am
@@ -16,9 +16,9 @@ doc_DATA = bitpacking.html datastructures.html decoding.html encoding.html\
 	ogg_sync_destroy.html ogg_sync_init.html ogg_sync_pageout.html\
 	ogg_sync_pageseek.html ogg_sync_reset.html ogg_sync_state.html\
 	ogg_sync_wrote.html oggpack_adv.html oggpack_adv1.html\
-	oggpack_adv_huff.html oggpack_bits.html oggpack_buffer.html\
+	oggpack_bits.html oggpack_buffer.html\
 	oggpack_bytes.html oggpack_get_buffer.html oggpack_look.html\
-	oggpack_look1.html oggpack_look_huff.html oggpack_read.html\
+	oggpack_look1.html oggpack_read.html\
 	oggpack_read1.html oggpack_readinit.html oggpack_reset.html\
 	oggpack_write.html oggpack_writeclear.html oggpack_writeinit.html\
 	overview.html reference.html style.css vorbis_comment.html\
diff --git a/doc/ogg/bitpacking.html b/doc/ogg/bitpacking.html
index cc5ec3c..1ead8dd 100644
--- a/doc/ogg/bitpacking.html
+++ b/doc/ogg/bitpacking.html
@@ -49,10 +49,6 @@ All the <b>libogg</b> specific functions are declared in "ogg/ogg.h".
 	<td>Look at a specified number of bits, <=32, without advancing the location pointer.</td>
 </tr>
 <tr valign=top>
-<td><a href="oggpack_look_huff.html">oggpack_look_huff</a></td>
-	<td>Look at a specified number of bits, <=8, without advancing the location pointer.</td>
-</tr>
-<tr valign=top>
 <td><a href="oggpack_look1.html">oggpack_look1</a></td>
 	<td>Looks at one bit without advancing the location pointer.</td>
 </tr>
@@ -61,10 +57,6 @@ All the <b>libogg</b> specific functions are declared in "ogg/ogg.h".
 	<td>Advances the location pointer by a specified number of bits.</td>
 </tr>
 <tr valign=top>
-<td><a href="oggpack_adv_huff.html">oggpack_adv_huff</a></td>
-	<td>Advances the location pointer by a specified number of bits, and checks for buffer overflow.</td>
-</tr>
-<tr valign=top>
 <td><a href="oggpack_adv1.html">oggpack_adv1</a></td>
 	<td>Advances the location pointer by one bit.</td>
 </tr>
diff --git a/doc/ogg/oggpack_adv.html b/doc/ogg/oggpack_adv.html
index 14ee8e2..1e7efb7 100644
--- a/doc/ogg/oggpack_adv.html
+++ b/doc/ogg/oggpack_adv.html
@@ -18,7 +18,6 @@
 <p><i>declared in "ogg/ogg.h";</i></p>
 
 <p>This function advances the location pointer by the specified number of bits without reading any data.
-<p>To also check for overflow while advancing, use <a href="oggpack_adv_huff.html">oggpack_adv_huff</a> instead.
 
 <br><br>
 <table border=0 color=black cellspacing=0 cellpadding=7>
@@ -51,11 +50,11 @@ No values are returned.</li>
 <hr noshade>
 <table border=0 width=100%>
 <tr valign=top>
-<td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
+<td><p class=tiny>copyright &copy; 2002 Xiph.org Foundation</p></td>
 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
 </tr><tr>
 <td><p class=tiny>libogg documentation</p></td>
-<td align=right><p class=tiny>libogg version 1.25 - 20000615</p></td>
+<td align=right><p class=tiny>libogg version 1.25 - 20020719</p></td>
 </tr>
 </table>
 
diff --git a/doc/ogg/oggpack_adv_huff.html b/doc/ogg/oggpack_adv_huff.html
deleted file mode 100644
index 8d6fc73..0000000
--- a/doc/ogg/oggpack_adv_huff.html
+++ /dev/null
@@ -1,67 +0,0 @@
-<html>
-
-<head>
-<title>libogg - function - oggpack_adv_huff</title>
-<link rel=stylesheet href="style.css" type="text/css">
-</head>
-
-<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
-<table border=0 width=100%>
-<tr>
-<td><p class=tiny>libogg documentation</p></td>
-<td align=right><p class=tiny>libogg version 1.25 - 20000615</p></td>
-</tr>
-</table>
-
-<h1>oggpack_adv_huff</h1>
-
-<p><i>declared in "ogg/ogg.h";</i></p>
-
-<p>This function advances the location pointer by the specified number of bits without reading any data.
-<p>This also checks for buffer overflow.
-
-<br><br>
-<table border=0 color=black cellspacing=0 cellpadding=7>
-<tr bgcolor=#cccccc>
-	<td>
-<pre><b>
-int oggpack_adv_huff(oggpack_buffer *b,int bits);
-</b></pre>
-	</td>
-</tr>
-</table>
-
-<h3>Parameters</h3>
-<dl>
-<dt><i>b</i></dt>
-<dd>Pointer to the current oggpack_buffer.</dd>
-<dt><i>bits</i></dt>
-<dd>Number of bits to advance.</dd>
-</dl>
-
-
-<h3>Return Values</h3>
-<blockquote>
-<li>
--1 on buffer overflow.</li>
-<li>
-0 in all other cases.</li>
-</blockquote>
-<p>
-
-<br><br>
-<hr noshade>
-<table border=0 width=100%>
-<tr valign=top>
-<td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
-</tr><tr>
-<td><p class=tiny>libogg documentation</p></td>
-<td align=right><p class=tiny>libogg version 1.25 - 20000615</p></td>
-</tr>
-</table>
-
-
-</body>
-
-</html>
diff --git a/doc/ogg/oggpack_look.html b/doc/ogg/oggpack_look.html
index e0fae99..a16fbcc 100644
--- a/doc/ogg/oggpack_look.html
+++ b/doc/ogg/oggpack_look.html
@@ -20,7 +20,6 @@
 <p>This function looks at a specified number of bits inside the buffer without advancing the location pointer.
 <p>The specified number of bits are read, starting from the location pointer.
 <p>This function can be used to read 32 or fewer bits.
-<p><a href="oggpack_look_huff.html">oggpack_look_huff()</a> can be used instead to read 8 or fewer bits.
 
 <br><br>
 <table border=0 color=black cellspacing=0 cellpadding=7>
diff --git a/doc/ogg/oggpack_look_huff.html b/doc/ogg/oggpack_look_huff.html
deleted file mode 100644
index b885287..0000000
--- a/doc/ogg/oggpack_look_huff.html
+++ /dev/null
@@ -1,68 +0,0 @@
-<html>
-
-<head>
-<title>libogg - function - oggpack_look_huff</title>
-<link rel=stylesheet href="style.css" type="text/css">
-</head>
-
-<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
-<table border=0 width=100%>
-<tr>
-<td><p class=tiny>libogg documentation</p></td>
-<td align=right><p class=tiny>libogg version 1.25 - 20000615</p></td>
-</tr>
-</table>
-
-<h1>oggpack_look_huff</h1>
-
-<p><i>declared in "ogg/ogg.h";</i></p>
-
-<p>This function looks at a specified number of bits inside the buffer without advancing the location pointer.
-<p>The specified number of bits are read, starting from the location pointer.
-<p>This function can be used to look at 8 or fewer bits.
-<p>To look at more bits, <a href="oggpack_look.html">oggpack_look</a> can be used instead to read 32 or fewer bits.
-
-
-<br><br>
-<table border=0 color=black cellspacing=0 cellpadding=7>
-<tr bgcolor=#cccccc>
-	<td>
-<pre><b>
-long  oggpack_look_huff(oggpack_buffer *b,int bits);
-</b></pre>
-</td>
-</tr>
-</table>
-
-<h3>Parameters</h3>
-<dl>
-<dt><i>b</i></dt>
-<dd>Pointer to <a href="oggpack_buffer.html">oggpack_buffer</a> to be read.</dd>
-<dt><i>bits</i></dt>
-<dd>Number of bits to look at.  For this function, must be 8 or fewer.</dd>
-</dl>
-
-
-<h3>Return Values</h3>
-<blockquote>
-<li>
-<i>n</i> represents the requested bits.</li>
-</blockquote>
-<p>
-
-<br><br>
-<hr noshade>
-<table border=0 width=100%>
-<tr valign=top>
-<td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
-</tr><tr>
-<td><p class=tiny>libogg documentation</p></td>
-<td align=right><p class=tiny>libogg version 1.25 - 20000615</p></td>
-</tr>
-</table>
-
-
-</body>
-
-</html>
diff --git a/doc/ogg/reference.html b/doc/ogg/reference.html
index d3decc8..06005fb 100644
--- a/doc/ogg/reference.html
+++ b/doc/ogg/reference.html
@@ -30,10 +30,8 @@
 <a href="oggpack_readinit.html">oggpack_readinit()</a><br>
 <a href="oggpack_write.html">oggpack_write()</a><br>
 <a href="oggpack_look.html">oggpack_look()</a><br>
-<a href="oggpack_look_huff.html">oggpack_look_huff()</a><br>
 <a href="oggpack_look1.html">oggpack_look1()</a><br>
 <a href="oggpack_adv.html">oggpack_adv()</a><br>
-<a href="oggpack_adv_huff.html">oggpack_adv_huff()</a><br>
 <a href="oggpack_adv1.html">oggpack_adv1()</a><br>
 <a href="oggpack_read.html">oggpack_read()</a><br>
 <a href="oggpack_read1.html">oggpack_read1()</a><br>
author	Ralph Giles <giles@xiph.org>	2002-07-19 11:03:39 +0000
committer	Ralph Giles <giles@xiph.org>	2002-07-19 11:03:39 +0000
commit	6ff3cbbe36a23ba7e648a23df40b86ace7ee711d (patch)
tree	f40086f1919dd4717db37fa6ed8124ec74b0759a /doc
parent	075adf68d5ce9018c6a52c97b224bfdef0cac4d5 (diff)
download	ogg-6ff3cbbe36a23ba7e648a23df40b86ace7ee711d.tar.gz