Skip to content

Commit bb2c5d8

Browse files
author
Timothy O'Brien
committed
Added another section to the index page, more content. Codec in general needs more documentation, and another release.
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/codec/trunk@130175 13f79535-47bb-0310-9956-ffa450edef68
1 parent 1dcf683 commit bb2c5d8

1 file changed

Lines changed: 29 additions & 3 deletions

File tree

xdocs/index.xml

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,38 @@
1212
<section name="Commons Codec">
1313

1414
<p>
15-
Welcome, to Commons Codec. Common Codec is an attempt to provide
16-
definitive implementations of commonly used encoders and decoders.
15+
Welcome. Commons Codec provides implementations of common
16+
encoders and decoders such as Base64, Hex, various phonetic
17+
encodings, and URLs.
1718
</p>
1819

1920
</section>
2021

22+
<section name="Impetus">
23+
<p>
24+
Codec was formed as an attempt to focus development effort on one
25+
definitive implementation of the Base64 encoder. At the time of
26+
Codec's proposal, there were approximately 34 different Java
27+
classes that dealt with Base64 encoding spread over the
28+
Foundation's CVS repository. Developers in the Jakarta Tomcat
29+
project had implemented an original version of the Base64 codec
30+
which had been copied by the Commons HttpClient and Apache XML
31+
project's XML-RPC subproject. After almost one year, the two
32+
forked versions of Base64 had significantly diverged from one
33+
another. XML-RPC had applied numerous fixes and patches which
34+
were not applied to the Commons HttpClient Base64. Different
35+
subprojects had differing implementations at various levels
36+
of compliance with the RFC 2045.
37+
</p>
38+
<p>
39+
Out of that confusing duplication of effort sprang this simple
40+
attempt to encourage code reuse among various projects. While
41+
this package contains a abstract framework for the creation
42+
encoders and decoders, Codec itself is primarily focused on
43+
providing functional utilities for working with common encodings.
44+
</p>
45+
</section>
46+
2147
<section name="Releases">
2248
<ul>
2349
<li>Version 1.1 (from mirror)
@@ -30,7 +56,7 @@
3056

3157
<p>
3258
Codec is currently comprised of a modest set of utilities and a
33-
simple framework for String encoding and decoding.
59+
simple framework for encoding and decoding both textual and binary data.
3460
</p>
3561

3662
<subsection name="Common Encoders">

0 commit comments

Comments
 (0)