Skip to content

Commit 5839ea5

Browse files
garydgregorygarydgregory
committed
Javadoc.
- Add missing package level Javadoc. - Add missing p tags - Simplify top level package documentation by linking.
1 parent a327e2c commit 5839ea5

5 files changed

Lines changed: 64 additions & 105 deletions

File tree

‎src/main/java/org/apache/commons/codec/cli/package.html‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one or more
3+
contributor license agreements. See the NOTICE file distributed with
4+
this work for additional information regarding copyright ownership.
5+
The ASF licenses this file to You under the Apache License, Version 2.0
6+
(the "License"); you may not use this file except in compliance with
7+
the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
<html>
18+
<body>
19+
<p>Command line utility.</p>
20+
</body>
21+
</html>

‎src/main/java/org/apache/commons/codec/digest/package.html‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@
1515
limitations under the License.
1616
-->
1717
<html>
18-
<body>
19-
Simplifies common {@link java.security.MessageDigest} tasks and
20-
includes a libc crypt(3) compatible crypt method that supports DES,
21-
MD5, SHA-256 and SHA-512 based algorithms as well as the Apache
22-
specific "$apr1$" variant.
23-
</body>
18+
<body>
19+
<p>
20+
Simplifies common {@link java.security.MessageDigest} tasks and
21+
includes a libc crypt(3) compatible crypt method that supports DES,
22+
MD5, SHA-256 and SHA-512 based algorithms as well as the Apache
23+
specific "$apr1$" variant.
24+
</p>
25+
</body>
2426
</html>

‎src/main/java/org/apache/commons/codec/language/package.html‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
limitations under the License.
1616
-->
1717
<html>
18-
<body>
19-
Language and phonetic encoders.
20-
</body>
18+
<body>
19+
<p>
20+
Language and phonetic encoders.
21+
</p>
22+
</body>
2123
</html>

‎src/main/java/org/apache/commons/codec/net/package.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
limitations under the License.
1616
-->
1717
<html>
18-
<body>
19-
<p>
20-
Network related encoding and decoding.
21-
</p>
22-
</body>
18+
<body>
19+
<p>
20+
Network related encoding and decoding.
21+
</p>
22+
</body>
2323
</html>

‎src/main/java/org/apache/commons/codec/package.html‎

Lines changed: 25 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -16,95 +16,29 @@
1616
-->
1717
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1818
<html>
19-
<head>
20-
</head>
21-
<body>
22-
<p>Interfaces and classes used by
23-
the various implementations in the sub-packages.</p>
24-
25-
<p>Definitive implementations of commonly used encoders and decoders.</p>
26-
27-
<p>Codec is currently comprised of a modest set of utilities and a
28-
simple framework for String encoding and decoding in three categories:
29-
Binary Encoders, Language Encoders, and Network Encoders. </p>
30-
31-
<h2>
32-
<a id="Common_Encoders"></a>Common Encoders
33-
</h2>
34-
35-
<table border="1">
36-
<caption>Binary Encoders</caption>
37-
<tbody>
38-
<tr>
39-
<td>
40-
<a href="binary/Base64.html">
41-
org.apache.commons.codec.binary.Base64</a>
42-
</td>
43-
<td>
44-
Provides Base64 content-transfer-encoding as defined in
45-
<a href="http://www.ietf.org/rfc/rfc2045.txt"> RFC 2045</a>
46-
</td>
47-
<td>Production</td>
48-
</tr>
49-
<tr>
50-
<td>
51-
<a href="binary/Hex.html">
52-
org.apache.commons.codec.binary.Hex</a>
53-
</td>
54-
<td>
55-
Converts an array of bytes into an array of characters
56-
representing the hexadecimal values of each byte in order
57-
</td>
58-
<td>Production</td>
59-
</tr>
60-
</tbody>
61-
</table>
62-
63-
<h2>
64-
<a id="Language_Encoders">Language Encoders</a>
65-
</h2>
66-
<p>
67-
Codec contains a number of commonly used language and phonetic
68-
encoders
69-
</p>
70-
71-
<table border="1">
72-
<caption>Language Encoders</caption>
73-
<tbody>
74-
<tr>
75-
<td>
76-
<a href="#">org.apache.commons.codec.language.Soundex</a>
77-
</td>
78-
<td>Implementation of the Soundex algorithm.</td>
79-
<td>Production</td>
80-
</tr>
81-
<tr>
82-
<td>
83-
<a href="#">org.apache.commons.codec.language.Metaphone</a>
84-
</td>
85-
<td>Implementation of the Metaphone algorithm.</td>
86-
<td>Production</td>
87-
</tr>
88-
</tbody>
89-
</table>
90-
91-
<h2>
92-
<a id="Network_Encoders">Network Encoders</a>
93-
</h2>
94-
<p> Codec contains network related encoders </p>
95-
96-
<table border="1">
97-
<caption>Network Encoders</caption>
98-
<tbody>
99-
<tr>
100-
<td>
101-
<a href="#">org.apache.commons.codec.net.URLCodec</a>
102-
</td>
103-
<td>Implements the 'www-form-urlencoded' encoding scheme.</td>
104-
<td>Production</td>
105-
</tr>
106-
</tbody>
107-
</table>
108-
<br>
109-
</body>
19+
<head>
20+
</head>
21+
<body>
22+
<p>Interfaces and classes used by the various implementations in
23+
the sub-packages.</p>
24+
25+
<p>Definitive implementations of commonly used encoders and
26+
decoders.</p>
27+
28+
<p>Codec is currently comprised of a modest set of utilities and a
29+
simple framework for String encoding and decoding in the following
30+
packages:</p>
31+
32+
<ul>
33+
<li><a href="binary/package-summary.html">Binary codecs.</a></li>
34+
<li><a href="cli/package-summary.html">Command line utility.</a></li>
35+
<li><a href="digest/package-summary.html">Digests and hashers</a></li>
36+
<li><a href="language/package-summary.html">Common language
37+
and phonetic encoders.</a></li>
38+
<li><a href="language/bm/package-summary.html">Beider-Morse
39+
codec.</a></li>
40+
<li><a href="net/package-summary.html">Network codecs.</a></li>
41+
</ul>
42+
43+
</body>
11044
</html>

0 commit comments

Comments
 (0)