commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tobr...@apache.org
Subject cvs commit: jakarta-commons/codec/xdocs index.xml
Date Thu, 31 Jul 2003 20:43:03 GMT
tobrien     2003/07/31 13:43:03

  Modified:    codec/xdocs index.xml
  Log:
  Added another section to the index page, more content.  Codec in general needs more documentation,
and another release.
  
  Revision  Changes    Path
  1.5       +29 -3     jakarta-commons/codec/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/codec/xdocs/index.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- index.xml	6 May 2003 22:56:11 -0000	1.4
  +++ index.xml	31 Jul 2003 20:43:03 -0000	1.5
  @@ -12,12 +12,38 @@
     <section name="Commons Codec">
   
      <p>
  -    Welcome, to Commons Codec.  Common Codec is an attempt to provide
  -    definitive implementations of commonly used encoders and decoders.
  +    Welcome.  Commons Codec provides implementations of common
  +    encoders and decoders such as Base64, Hex, various phonetic
  +    encodings, and URLs.
      </p>
   
     </section>
   
  +  <section name="Impetus">
  +   <p>
  +     Codec was formed as an attempt to focus development effort on one
  +     definitive implementation of the Base64 encoder.  At the time of
  +     Codec's proposal, there were approximately 34 different Java
  +     classes that dealt with Base64 encoding spread over the
  +     Foundation's CVS repository.  Developers in the Jakarta Tomcat
  +     project had implemented an original version of the Base64 codec
  +     which had been copied by the Commons HttpClient and Apache XML
  +     project's XML-RPC subproject.  After almost one year, the two
  +     forked versions of Base64 had significantly diverged from one
  +     another.  XML-RPC had applied numerous fixes and patches which
  +     were not applied to the Commons HttpClient Base64.  Different 
  +     subprojects had differing implementations at various levels
  +     of compliance with the RFC 2045.
  +   </p>
  +   <p>
  +     Out of that confusing duplication of effort sprang this simple
  +     attempt to encourage code reuse among various projects.  While
  +     this package contains a abstract framework for the creation
  +     encoders and decoders, Codec itself is primarily focused on
  +     providing functional utilities for working with common encodings.
  +   </p>
  +  </section>
  +
     <section name="Releases">
      <ul>
       <li>Version 1.1 (from mirror)
  @@ -30,7 +56,7 @@
   
      <p>
    	Codec is currently comprised of a modest set of utilities and a
  - 	simple framework for String encoding and decoding.
  + 	simple framework for encoding and decoding both textual and binary data.
      </p>
   
      <subsection name="Common Encoders">
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message