commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1080865 - /commons/proper/codec/trunk/src/site/xdoc/userguide.xml
Date Sat, 12 Mar 2011 06:05:28 GMT
Author: ggregory
Date: Sat Mar 12 06:05:28 2011
New Revision: 1080865

URL: http://svn.apache.org/viewvc?rev=1080865&view=rev
Log:
Bring up to date and match up with Javadocs.

Modified:
    commons/proper/codec/trunk/src/site/xdoc/userguide.xml

Modified: commons/proper/codec/trunk/src/site/xdoc/userguide.xml
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/site/xdoc/userguide.xml?rev=1080865&r1=1080864&r2=1080865&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/site/xdoc/userguide.xml (original)
+++ commons/proper/codec/trunk/src/site/xdoc/userguide.xml Sat Mar 12 06:05:28 2011
@@ -27,23 +27,42 @@
         <table>
           <tr>
             <td width="150">
+              <a href="apidocs/org/apache/commons/codec/binary/Base32.html">Base32
+              </a>
+            </td>
+            <td>
+              Provides Base32 encoding and decoding as defined by
+              <a href="http://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>
+            </td>
+          </tr>
+          <tr>
+            <td width="150">
+              <a
+                href="apidocs/org/apache/commons/codec/binary/Base32InputStream.html">Base32InputStream
+              </a>
+            </td>
+            <td>Provides Base32 encoding and decoding in a streaming
+              fashion (unlimited size).
+            </td>
+          </tr>
+          <tr>
+            <td width="150">
               <a href="apidocs/org/apache/commons/codec/binary/Base64.html"> Base64
               </a>
             </td>
             <td>
               Provides Base64 encoding and decoding as defined by
               <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>
-              . This encoder can optionally create 76 character chunked
-              output for strict adherence to RFC 2045.
             </td>
           </tr>
           <tr>
-            <td>
-              <a href="apidocs/org/apache/commons/codec/binary/Hex.html"> Hex
+            <td width="150">
+              <a
+                href="apidocs/org/apache/commons/codec/binary/Base64InputStream.html">Base64InputStream
               </a>
             </td>
-            <td> Converts an array of bytes into an array of characters
-              representing the hexadecimal values of each byte in order
+            <td>Provides Base64 encoding and decoding in a streaming
+              fashion (unlimited size).
             </td>
           </tr>
           <tr>
@@ -52,10 +71,35 @@
                 href="apidocs/org/apache/commons/codec/binary/BinaryCodec.html"> BinaryCodec
               </a>
             </td>
-            <td> Translates between byte arrays and strings of "0"s and
+            <td>Converts between byte arrays and strings of "0"s and
               "1"s.
             </td>
           </tr>
+          <tr>
+            <td>
+              <a href="apidocs/org/apache/commons/codec/binary/Hex.html"> Hex
+              </a>
+            </td>
+            <td>Converts hexadecimal Strings.
+            </td>
+          </tr>
+        </table>
+      </subsection>
+      <subsection name="Digest Encoders">
+        <table>
+          <tr>
+            <td width="150">
+              <a
+                href="apidocs/org/apache/commons/codec/digest/DigestUtils.html">DigestUtils
+              </a>
+            </td>
+            <td>
+              Simplifies common
+              <a
+                href="http://download.oracle.com/javase/1.4.2/docs/api/java/security/MessageDigest.html">MessageDigest</a>
+              tasks.
+            </td>
+          </tr>
         </table>
       </subsection>
       <subsection name="Language Encoders">
@@ -63,79 +107,70 @@
           <tr>
             <td width="150">
               <a
-                href="apidocs/org/apache/commons/codec/language/Soundex.html"> Soundex
+                href="apidocs/org/apache/commons/codec/language/Caverphone1.html">Caverphone
1.0
               </a>
             </td>
-            <td> Implementation of the Soundex algorithm.
+            <td>Encodes a string into a Caverphone 1.0 value.
             </td>
           </tr>
           <tr>
-            <td>
+            <td width="150">
               <a
-                href="apidocs/org/apache/commons/codec/language/Metaphone.html"> Metaphone
+                href="apidocs/org/apache/commons/codec/language/Caverphone2.html">Caverphone
2.0
               </a>
             </td>
-            <td> Implementation of the Metaphone algorithm.
+            <td>Encodes a string into a Caverphone 2.0 value.
             </td>
           </tr>
           <tr>
-            <td>
+            <td width="150">
               <a
-                href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html">
Refined Soundex
+                href="apidocs/org/apache/commons/codec/language/ColognePhonetic.html">Cologne
Phonetic
               </a>
             </td>
-            <td> Alternative implementation of the Soundex algorithm.
+            <td>Encodes a string into a Cologne Phonetic value.
             </td>
           </tr>
           <tr>
             <td>
               <a
-                href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html">
Double Metaphone
+                href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html">Double
Metaphone
               </a>
             </td>
-            <td> Alternative implementation of the Metaphone algorithm.
+            <td>Encodes a string into a double metaphone value.
             </td>
           </tr>
-        </table>
-      </subsection>
-      <subsection name="Digest Encoders">
-        <table>
           <tr>
-            <td width="150">
+            <td>
               <a
-                href="apidocs/org/apache/commons/codec/digest/DigestUtils.html"> DigestUtils
+                href="apidocs/org/apache/commons/codec/language/Metaphone.html">Metaphone
               </a>
             </td>
-            <td> Provides simple static methods for creating a SHA or
-              MD5 digest.
+            <td>Encodes a string into a Metaphone value.
             </td>
           </tr>
-        </table>
-      </subsection>
-      <subsection name="Network Encoders">
-        <table>
           <tr>
-            <td width="150">
-              <a href="apidocs/org/apache/commons/codec/net/URLCodec.html"> URLCodec
+            <td>
+              <a
+                href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html">Refined
Soundex
               </a>
             </td>
-            <td>
-              Implements the
-              <code>www-form-urlencoded</code>
-              encoding scheme, also misleadingly known as URL encoding.
+            <td>Encodes a string into a Refined Soundex value.
             </td>
           </tr>
           <tr>
             <td width="150">
               <a
-                href="apidocs/org/apache/commons/codec/net/QuotedPrintableCodec.html">
QuotedPrintableCodec
+                href="apidocs/org/apache/commons/codec/language/Soundex.html">Soundex
               </a>
             </td>
-            <td> Codec for RFC 1521 MIME (Multipurpose Internet Mail
-              Extensions) Part One. Rules #3, #4, and #5 of the
-              quoted-printable spec are not implemented yet
+            <td>Encodes a string into a Soundex value.
             </td>
           </tr>
+        </table>
+      </subsection>
+      <subsection name="Network Encoders">
+        <table>
           <tr>
             <td width="150">
               <a href="apidocs/org/apache/commons/codec/net/BCodec.html"> BCodec
@@ -161,6 +196,29 @@
               decoding.
             </td>
           </tr>
+          <tr>
+            <td width="150">
+              <a
+                href="apidocs/org/apache/commons/codec/net/QuotedPrintableCodec.html">
QuotedPrintableCodec
+              </a>
+            </td>
+            <td>
+              Codec for the Quoted-Printable section of
+              <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>
+              .
+            </td>
+          </tr>
+          <tr>
+            <td width="150">
+              <a href="apidocs/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>
         </table>
       </subsection>
     </section>



Mime
View raw message