Improvements to the documentation for the 2.2 release. Added in the upgrade page (empty until the release notes are complete), changed users/developers guide to user/developer guide, and added the text package to the user guide.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@447022 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Henri Yandell 2006-09-17 08:00:26 +00:00
parent 6c33df75fa
commit 838d27ab68
5 changed files with 67 additions and 20 deletions

View File

@ -29,6 +29,8 @@ limitations under the License.
</p>
<p>
You may also be interested in the upgrade notes:<br />
<br />
Upgrade <a href="upgradeto2_2.html">from 2.1 to 2.2</a><br />
Upgrade <a href="upgradeto2_1.html">from 2.0 to 2.1</a><br />
Upgrade <a href="upgradeto2_0.html">from 1.0 to 2.0</a><br />
</p>

View File

@ -20,14 +20,15 @@ limitations under the License.
</properties>
<body>
<!-- $Id$ -->
<section name='Developers guide for Jakarta Commons "Lang"'>
<section name='Developer guide for Jakarta Commons "Lang"'>
<div align="center">
<h1>The Jakarta Commons <em>Lang</em> Package</h1>
<h2>Developers Guide</h2>
$Id$<br />
<br />
<a href="#Introduction">[Introduction]</a>
<a href="#PackageStructure">[Package Structure]</a>
<a href="#UtilityClasses">[Utility Classes]</a>
@ -41,7 +42,7 @@ $Id$<br />
<h3>1. INTRODUCTION</h3>
<p>The <em>Lang</em> package contains a set of Java classes that extend
the basic JDK classes. This developers guide seeks to set
the basic JDK classes. This developer guide seeks to set
out rules for the naming of classes and methods within the package. The purpose
of this, as with all naming standards, is to improve the coherency and
consistency of the whole API.</p>

View File

@ -28,7 +28,7 @@ limitations under the License.
<menu name="Commons Lang">
<item name="Overview" href="/index.html"/>
<item name="Download" href="http://jakarta.apache.org/site/downloads/downloads_commons-lang.cgi"/>
<item name="Users guide" href="/userguide.html"/>
<item name="User guide" href="/userguide.html"/>
<item name="Javadoc (2.2 release)" href="api-release/index.html"/>
</menu>
@ -38,7 +38,7 @@ limitations under the License.
<item name="Team" href="/team-list.html"/>
<item name="Tasks" href="/tasks.html"/>
<item name="Proposal" href="/proposal.html"/>
<item name="Developers guide" href="/developerguide.html"/>
<item name="Developer guide" href="/developerguide.html"/>
<item name="SVN repository" href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/lang/trunk/"/>
<item name="Javadoc (SVN latest)" href="apidocs/index.html"/>
</menu>

41
xdocs/upgradeto2_2.xml Normal file
View File

@ -0,0 +1,41 @@
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Upgrade from 2.1 to 2.2</title>
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
</properties>
<body>
<section name="Upgrade">
<p>
These are the release notes and advice for upgrading Commons-Lang from
version 2.1 to version 2.2.
<source>
INTRODUCTION:
This document contains the release notes for the 2.2 version of Apache Jakarta Commons Lang.
Commons Lang is a set of utility functions and reusable components that
should be of use in any Java environment.
</source>
</p>
</section>
</body>
</document>

View File

@ -19,17 +19,18 @@ limitations under the License.
<document>
<properties>
<title>Commons Lang - Users guide</title>
<title>Commons Lang - User guide</title>
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
</properties>
<body>
<!-- $Id$ -->
<section name='Users guide for Jakarta Commons "Lang"'>
<section name='User guide for Jakarta Commons "Lang"'>
<div align="center">
<h1>The Jakarta Commons <em>Lang</em> Package</h1>
<h2>Users Guide</h2>
$Id$<br />
<br />
<a href="#Description">[Description]</a>
<a href="#lang.*">[lang.*]</a>
<a href="#lang.builder.*">[lang.builder.*]</a>
@ -37,6 +38,7 @@ $Id$<br />
<a href="#lang.exception.*">[lang.exception.*]</a>
<a href="#lang.math.*">[lang.math.*]</a>
<a href="#lang.mutable.*">[lang.mutable.*]</a>
<a href="#lang.text.*">[lang.text.*]</a>
<a href="#lang.time.*">[lang.time.*]</a>
<br /><br />
</div>
@ -208,6 +210,19 @@ public final class ColorEnum extends Enum {
</p>
</section>
<a name="lang.text.*"></a>
<section name="lang.text.*">
<!--
CompositeFormat
StrLookup
StrSubstitutor
StrBuilder
StrMatcher
StrTokenizer
-->
<p>The text package was added in Lang 2.2. </p>
</section>
<a name="lang.time.*"></a>
<section name="lang.time.*">
<!--
@ -221,17 +236,5 @@ public final class ColorEnum extends Enum {
<p>New in Lang 2.1 is the DurationFormatUtils class, which provides various methods for formatting durations. </p>
</section>
<section name="lang.text.*">
<!--
CompositeFormat
StrLookup
StrSubstitutor
StrBuilder
StrMatcher
StrTokenizer
-->
<p>The text package was added in Lang 2.2. </p>
</section>
</body>
</document>