Skip to content

Commit 82e2d03

Browse files
garydgregorygarydgregory
committed
Bring up to date and match up with Javadocs.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1080865 13f79535-47bb-0310-9956-ffa450edef68
1 parent 6143f57 commit 82e2d03

1 file changed

Lines changed: 97 additions & 39 deletions

File tree

‎src/site/xdoc/userguide.xml‎

Lines changed: 97 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,26 @@
2525
the sub-packages.
2626
</p>
2727
<table>
28+
<tr>
29+
<td width="150">
30+
<a href="apidocs/org/apache/commons/codec/binary/Base32.html">Base32
31+
</a>
32+
</td>
33+
<td>
34+
Provides Base32 encoding and decoding as defined by
35+
<a href="http://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>
36+
</td>
37+
</tr>
38+
<tr>
39+
<td width="150">
40+
<a
41+
href="apidocs/org/apache/commons/codec/binary/Base32InputStream.html">Base32InputStream
42+
</a>
43+
</td>
44+
<td>Provides Base32 encoding and decoding in a streaming
45+
fashion (unlimited size).
46+
</td>
47+
</tr>
2848
<tr>
2949
<td width="150">
3050
<a href="apidocs/org/apache/commons/codec/binary/Base64.html"> Base64
@@ -33,17 +53,16 @@
3353
<td>
3454
Provides Base64 encoding and decoding as defined by
3555
<a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>
36-
. This encoder can optionally create 76 character chunked
37-
output for strict adherence to RFC 2045.
3856
</td>
3957
</tr>
4058
<tr>
41-
<td>
42-
<a href="apidocs/org/apache/commons/codec/binary/Hex.html"> Hex
59+
<td width="150">
60+
<a
61+
href="apidocs/org/apache/commons/codec/binary/Base64InputStream.html">Base64InputStream
4362
</a>
4463
</td>
45-
<td> Converts an array of bytes into an array of characters
46-
representing the hexadecimal values of each byte in order
64+
<td>Provides Base64 encoding and decoding in a streaming
65+
fashion (unlimited size).
4766
</td>
4867
</tr>
4968
<tr>
@@ -52,90 +71,106 @@
5271
href="apidocs/org/apache/commons/codec/binary/BinaryCodec.html"> BinaryCodec
5372
</a>
5473
</td>
55-
<td> Translates between byte arrays and strings of "0"s and
74+
<td>Converts between byte arrays and strings of "0"s and
5675
"1"s.
5776
</td>
5877
</tr>
78+
<tr>
79+
<td>
80+
<a href="apidocs/org/apache/commons/codec/binary/Hex.html"> Hex
81+
</a>
82+
</td>
83+
<td>Converts hexadecimal Strings.
84+
</td>
85+
</tr>
86+
</table>
87+
</subsection>
88+
<subsection name="Digest Encoders">
89+
<table>
90+
<tr>
91+
<td width="150">
92+
<a
93+
href="apidocs/org/apache/commons/codec/digest/DigestUtils.html">DigestUtils
94+
</a>
95+
</td>
96+
<td>
97+
Simplifies common
98+
<a
99+
href="http://download.oracle.com/javase/1.4.2/docs/api/java/security/MessageDigest.html">MessageDigest</a>
100+
tasks.
101+
</td>
102+
</tr>
59103
</table>
60104
</subsection>
61105
<subsection name="Language Encoders">
62106
<table>
63107
<tr>
64108
<td width="150">
65109
<a
66-
href="apidocs/org/apache/commons/codec/language/Soundex.html"> Soundex
110+
href="apidocs/org/apache/commons/codec/language/Caverphone1.html">Caverphone 1.0
67111
</a>
68112
</td>
69-
<td> Implementation of the Soundex algorithm.
113+
<td>Encodes a string into a Caverphone 1.0 value.
70114
</td>
71115
</tr>
72116
<tr>
73-
<td>
117+
<td width="150">
74118
<a
75-
href="apidocs/org/apache/commons/codec/language/Metaphone.html"> Metaphone
119+
href="apidocs/org/apache/commons/codec/language/Caverphone2.html">Caverphone 2.0
76120
</a>
77121
</td>
78-
<td> Implementation of the Metaphone algorithm.
122+
<td>Encodes a string into a Caverphone 2.0 value.
79123
</td>
80124
</tr>
81125
<tr>
82-
<td>
126+
<td width="150">
83127
<a
84-
href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html"> Refined Soundex
128+
href="apidocs/org/apache/commons/codec/language/ColognePhonetic.html">Cologne Phonetic
85129
</a>
86130
</td>
87-
<td> Alternative implementation of the Soundex algorithm.
131+
<td>Encodes a string into a Cologne Phonetic value.
88132
</td>
89133
</tr>
90134
<tr>
91135
<td>
92136
<a
93-
href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html"> Double Metaphone
137+
href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html">Double Metaphone
94138
</a>
95139
</td>
96-
<td> Alternative implementation of the Metaphone algorithm.
140+
<td>Encodes a string into a double metaphone value.
97141
</td>
98142
</tr>
99-
</table>
100-
</subsection>
101-
<subsection name="Digest Encoders">
102-
<table>
103143
<tr>
104-
<td width="150">
144+
<td>
105145
<a
106-
href="apidocs/org/apache/commons/codec/digest/DigestUtils.html"> DigestUtils
146+
href="apidocs/org/apache/commons/codec/language/Metaphone.html">Metaphone
107147
</a>
108148
</td>
109-
<td> Provides simple static methods for creating a SHA or
110-
MD5 digest.
149+
<td>Encodes a string into a Metaphone value.
111150
</td>
112151
</tr>
113-
</table>
114-
</subsection>
115-
<subsection name="Network Encoders">
116-
<table>
117152
<tr>
118-
<td width="150">
119-
<a href="apidocs/org/apache/commons/codec/net/URLCodec.html"> URLCodec
153+
<td>
154+
<a
155+
href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html">Refined Soundex
120156
</a>
121157
</td>
122-
<td>
123-
Implements the
124-
<code>www-form-urlencoded</code>
125-
encoding scheme, also misleadingly known as URL encoding.
158+
<td>Encodes a string into a Refined Soundex value.
126159
</td>
127160
</tr>
128161
<tr>
129162
<td width="150">
130163
<a
131-
href="apidocs/org/apache/commons/codec/net/QuotedPrintableCodec.html"> QuotedPrintableCodec
164+
href="apidocs/org/apache/commons/codec/language/Soundex.html">Soundex
132165
</a>
133166
</td>
134-
<td> Codec for RFC 1521 MIME (Multipurpose Internet Mail
135-
Extensions) Part One. Rules #3, #4, and #5 of the
136-
quoted-printable spec are not implemented yet
167+
<td>Encodes a string into a Soundex value.
137168
</td>
138169
</tr>
170+
</table>
171+
</subsection>
172+
<subsection name="Network Encoders">
173+
<table>
139174
<tr>
140175
<td width="150">
141176
<a href="apidocs/org/apache/commons/codec/net/BCodec.html"> BCodec
@@ -161,6 +196,29 @@
161196
decoding.
162197
</td>
163198
</tr>
199+
<tr>
200+
<td width="150">
201+
<a
202+
href="apidocs/org/apache/commons/codec/net/QuotedPrintableCodec.html"> QuotedPrintableCodec
203+
</a>
204+
</td>
205+
<td>
206+
Codec for the Quoted-Printable section of
207+
<a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>
208+
.
209+
</td>
210+
</tr>
211+
<tr>
212+
<td width="150">
213+
<a href="apidocs/org/apache/commons/codec/net/URLCodec.html"> URLCodec
214+
</a>
215+
</td>
216+
<td>
217+
Implements the
218+
<code>www-form-urlencoded</code>
219+
encoding scheme, also misleadingly known as URL encoding.
220+
</td>
221+
</tr>
164222
</table>
165223
</subsection>
166224
</section>

0 commit comments

Comments
 (0)