Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
- Add entry for newer class
- Fix class name reference
- Remove extra whitespace
  • Loading branch information
garydgregory committed Jan 22, 2025
1 parent b9ac851 commit fe5a92c
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions src/main/javadoc/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ <h1>Digest Encoders</h1>
<td>The libc crypt() "$1$" and Apache "$apr1$" MD5-based hash algorithm.</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/digest/MurmurHash1.html">MurmurHash1</a></td>
<td>Implementation of the MurmurHash1 32-bit and 64-bit hash functions.</td>
<td><a href="org/apache/commons/codec/digest/MurmurHash2.html">MurmurHash2</a></td>
<td>Implementation of the MurmurHash2 32-bit and 64-bit hash functions.</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/digest/MurmurHash3.html">MurmurHash3</a></td>
Expand Down Expand Up @@ -153,31 +153,35 @@ <h1>Language Encoders</h1>
<table>
<caption>Language Encoders</caption>
<tr>
<td><a href="org/apache/commons/codec/language/Caverphone1.html">Caverphone 1.0 </a></td>
<td><a href="org/apache/commons/codec/language/Caverphone1.html">Caverphone 1.0</a></td>
<td>Encodes a string into a Caverphone 1.0 value.</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/language/Caverphone2.html">Caverphone 2.0 </a></td>
<td><a href="org/apache/commons/codec/language/Caverphone2.html">Caverphone 2.0</a></td>
<td>Encodes a string into a Caverphone 2.0 value.</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/language/ColognePhonetic.html">Cologne Phonetic </a></td>
<td><a href="org/apache/commons/codec/language/ColognePhonetic.html">Cologne Phonetic</a></td>
<td>Encodes a string into a Cologne Phonetic value.</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/language/DoubleMetaphone.html">Double Metaphone </a></td>
<td><a href="org/apache/commons/codec/language/DaitchMokotoffSoundex.html">Daitch-Mokotoff Soundex</a></td>
<td>Encodes a string into a Daitch-Mokotoff Soundex value.</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/language/DoubleMetaphone.html">Double Metaphone</a></td>
<td>Encodes a string into a double metaphone value.</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/language/Metaphone.html">Metaphone </a></td>
<td><a href="org/apache/commons/codec/language/Metaphone.html">Metaphone</a></td>
<td>Encodes a string into a Metaphone value.</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/language/RefinedSoundex.html">Refined Soundex </a></td>
<td><a href="org/apache/commons/codec/language/RefinedSoundex.html">Refined Soundex</a></td>
<td>Encodes a string into a Refined Soundex value.</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/language/Soundex.html">Soundex </a></td>
<td><a href="org/apache/commons/codec/language/Soundex.html">Soundex</a></td>
<td>Encodes a string into a Soundex value.</td>
</tr>
</table>
Expand All @@ -187,28 +191,28 @@ <h1>Network Encoders</h1>
<table>
<caption>Network Encoders</caption>
<tr>
<td><a href="org/apache/commons/codec/net/BCodec.html"> BCodec </a></td>
<td><a href="org/apache/commons/codec/net/BCodec.html">BCodec</a></td>
<td>Identical to the Base64 encoding defined by <a href="https://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> and allows a character set to be
specified.
</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/net/PercentCodec.html"> PercentCodec </a></td>
<td><a href="org/apache/commons/codec/net/PercentCodec.html">PercentCodec</a></td>
<td>Implements the Percent-Encoding scheme, as described in HTTP 1.1 specification.</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/net/QCodec.html"> QCodec </a></td>
<td><a href="org/apache/commons/codec/net/QCodec.html">QCodec</a></td>
<td>Similar to the Quoted-Printable content-transfer-encoding defined in <a href="https://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> and designed
to allow text containing mostly ASCII characters to be decipherable on an ASCII terminal without decoding.
</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/net/QuotedPrintableCodec.html"> QuotedPrintableCodec </a></td>
<td><a href="org/apache/commons/codec/net/QuotedPrintableCodec.html">QuotedPrintableCodec</a></td>
<td>Codec for the Quoted-Printable section of <a href="https://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> .
</td>
</tr>
<tr>
<td><a href="org/apache/commons/codec/net/URLCodec.html"> URLCodec </a></td>
<td><a href="org/apache/commons/codec/net/URLCodec.html">URLCodec</a></td>
<td>Implements the <code>www-form-urlencoded</code> encoding scheme, also misleadingly known as URL encoding.
</td>
</tr>
Expand Down

0 comments on commit fe5a92c

Please sign in to comment.