Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Include a Javadoc overview. 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137351 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2003-05-31 18:44:36 +00:00
parent 9503cd07e9
commit e7d0572cf8
2 changed files with 164 additions and 232 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

389
build.xml
View File

@ -1,159 +1,103 @@
<project name="Lang" default="compile" basedir="."> <project name="Lang" default="compile" basedir=".">
<!--
<!--
"Lang" component of the Jakarta Commons Subproject "Lang" component of the Jakarta Commons Subproject
$Id: build.xml,v 1.11 2003/05/23 03:52:09 ggregory Exp $ $Id: build.xml,v 1.12 2003/05/31 18:44:36 ggregory Exp $
--> -->
<!-- ========== Initialize Properties ===================================== -->
<property file="${user.home}/${component.name}.build.properties"/>
<!-- ========== Initialize Properties ===================================== --> <property file="${user.home}/build.properties"/>
<property file="${basedir}/build.properties"/>
<property file="${user.home}/${component.name}.build.properties" /> <property file="${basedir}/default.properties"/>
<property file="${user.home}/build.properties" /> <!-- ========== Construct compile classpath =============================== -->
<property file="${basedir}/build.properties" /> <path id="compile.classpath">
<property file="${basedir}/default.properties" /> <pathelement location="${build.home}/classes"/>
</path>
<!-- ========== Construct compile classpath =============================== --> <!-- ========== Construct unit test classpath ============================= -->
<path id="test.classpath">
<path id="compile.classpath"> <pathelement location="${build.home}/classes"/>
<pathelement location="${build.home}/classes"/> <pathelement location="${build.home}/tests"/>
</path> <pathelement location="${junit.jar}"/>
</path>
<!-- ========== Construct unit test classpath ============================= --> <!-- ========== Executable Targets ======================================== -->
<target name="init" description="Initialize and evaluate conditionals">
<path id="test.classpath"> <echo message="-------- ${component.name} ${component.version} --------"/>
<pathelement location="${build.home}/classes"/> <filter token="name" value="${component.name}"/>
<pathelement location="${build.home}/tests"/> <filter token="package" value="${component.package}"/>
<pathelement location="${junit.jar}"/> <filter token="version" value="${component.version}"/>
</path> </target>
<target name="prepare" depends="init" description="Prepare build directory">
<!-- ========== Executable Targets ======================================== --> <mkdir dir="${build.home}"/>
<mkdir dir="${build.home}/classes"/>
<target name="init" <mkdir dir="${build.home}/conf"/>
description="Initialize and evaluate conditionals"> <mkdir dir="${build.home}/tests"/>
<echo message="-------- ${component.name} ${component.version} --------"/> </target>
<filter token="name" value="${component.name}"/> <target name="static" depends="prepare" description="Copy static files to build directory">
<filter token="package" value="${component.package}"/> <tstamp/>
<filter token="version" value="${component.version}"/> <copy todir="${build.home}/conf" filtering="on">
</target> <fileset dir="${conf.home}" includes="*.MF"/>
</copy>
</target>
<target name="prepare" depends="init" <target name="compile" depends="static" description="Compile shareable components">
description="Prepare build directory"> <javac srcdir="${source.home}" destdir="${build.home}/classes" debug="${compile.debug}" deprecation="${compile.deprecation}" optimize="${compile.optimize}">
<mkdir dir="${build.home}"/> <classpath refid="compile.classpath"/>
<mkdir dir="${build.home}/classes"/> </javac>
<mkdir dir="${build.home}/conf"/> <copy todir="${build.home}/classes" filtering="on">
<mkdir dir="${build.home}/tests"/> <fileset dir="${source.home}" excludes="**/*.java"/>
</target> </copy>
</target>
<target name="compile.tests" depends="compile" description="Compile unit test cases">
<target name="static" depends="prepare" <javac srcdir="${test.home}" destdir="${build.home}/tests" debug="${compile.debug}" deprecation="off" optimize="${compile.optimize}">
description="Copy static files to build directory"> <classpath refid="test.classpath"/>
<tstamp/> </javac>
<copy todir="${build.home}/conf" filtering="on"> <copy todir="${build.home}/tests" filtering="on">
<fileset dir="${conf.home}" includes="*.MF"/> <fileset dir="${test.home}" excludes="**/*.java"/>
</copy> </copy>
</target> </target>
<target name="clean" description="Clean build and distribution directories">
<delete dir="${build.home}"/>
<target name="compile" depends="static" <delete dir="${dist.home}"/>
description="Compile shareable components"> </target>
<javac srcdir="${source.home}" <target name="all" depends="clean,compile" description="Clean and compile all components"/>
destdir="${build.home}/classes" <target name="javadoc" depends="compile" description="Create component Javadoc documentation">
debug="${compile.debug}" <mkdir dir="${dist.home}"/>
deprecation="${compile.deprecation}" <mkdir dir="${dist.home}/docs"/>
optimize="${compile.optimize}"> <mkdir dir="${dist.home}/docs/api"/>
<classpath refid="compile.classpath"/> <javadoc
</javac> sourcepath="${source.home}"
<copy todir="${build.home}/classes" filtering="on"> destdir="${dist.home}/docs/api"
<fileset dir="${source.home}" excludes="**/*.java"/> overview="${source.home}/org/apache/commons/lang/overview.html"
</copy> packagenames="org.apache.commons.*"
</target> author="true"
private="true"
version="true"
<target name="compile.tests" depends="compile" doctitle="&lt;h1&gt;${component.title}&lt;/h1&gt;"
description="Compile unit test cases"> windowtitle="${component.title} (Version ${component.version})"
<javac srcdir="${test.home}" bottom="Copyright &amp;copy; 2001-2003 - Apache Software Foundation"
destdir="${build.home}/tests" use="true">
debug="${compile.debug}" <classpath refid="compile.classpath"/>
deprecation="off" </javadoc>
optimize="${compile.optimize}"> </target>
<classpath refid="test.classpath"/> <target name="dist" depends="compile,javadoc" description="Create binary distribution">
</javac> <mkdir dir="${dist.home}"/>
<copy todir="${build.home}/tests" filtering="on"> <copy file="../LICENSE" todir="${dist.home}"/>
<fileset dir="${test.home}" excludes="**/*.java"/> <copy file="RELEASE-NOTES.txt" todir="${dist.home}"/>
</copy> <antcall target="jar"/>
</target> </target>
<target name="jar" depends="compile" description="Create jar">
<mkdir dir="${dist.home}"/>
<target name="clean" <mkdir dir="${build.home}/classes/META-INF"/>
description="Clean build and distribution directories"> <copy file="../LICENSE" tofile="${build.home}/classes/META-INF/LICENSE.txt"/>
<delete dir="${build.home}"/> <jar jarfile="${dist.home}/${final.name}.jar" basedir="${build.home}/classes" manifest="${build.home}/conf/MANIFEST.MF"/>
<delete dir="${dist.home}"/> </target>
</target> <target name="install-jar" depends="jar" description="--> Installs jar file in ${lib.repo}">
<copy todir="${lib.repo}" filtering="no">
<fileset dir="${dist.home}">
<target name="all" depends="clean,compile" <include name="${final.name}.jar"/>
description="Clean and compile all components"/> </fileset>
</copy>
</target>
<target name="javadoc" depends="compile" <!-- ========== Unit Test Targets ========================================= -->
description="Create component Javadoc documentation"> <target name="test" depends="
<mkdir dir="${dist.home}"/>
<mkdir dir="${dist.home}/docs"/>
<mkdir dir="${dist.home}/docs/api"/>
<javadoc sourcepath="${source.home}"
destdir="${dist.home}/docs/api"
packagenames="org.apache.commons.*"
author="true"
private="true"
version="true"
doctitle="&lt;h1&gt;${component.title}&lt;/h1&gt;"
windowtitle="${component.title} (Version ${component.version})"
bottom="Copyright (c) 2001-2003 - Apache Software Foundation">
<classpath refid="compile.classpath"/>
</javadoc>
</target>
<target name="dist" depends="compile,javadoc"
description="Create binary distribution">
<mkdir dir="${dist.home}"/>
<copy file="../LICENSE"
todir="${dist.home}"/>
<copy file="RELEASE-NOTES.txt"
todir="${dist.home}"/>
<antcall target="jar"/>
</target>
<target name="jar" depends="compile"
description="Create jar">
<mkdir dir="${dist.home}"/>
<mkdir dir="${build.home}/classes/META-INF"/>
<copy file="../LICENSE"
tofile="${build.home}/classes/META-INF/LICENSE.txt"/>
<jar jarfile="${dist.home}/${final.name}.jar"
basedir="${build.home}/classes"
manifest="${build.home}/conf/MANIFEST.MF"/>
</target>
<target name="install-jar" depends="jar"
description="--> Installs jar file in ${lib.repo}">
<copy todir="${lib.repo}" filtering="no">
<fileset dir="${dist.home}">
<include name="${final.name}.jar"/>
</fileset>
</copy>
</target>
<!-- ========== Unit Test Targets ========================================= -->
<target name="test" depends="
compile.tests, compile.tests,
test.lang, test.lang,
test.builder, test.builder,
@ -162,82 +106,63 @@
test.math, test.math,
test.reflect, test.reflect,
test.time, test.time,
test.util" test.util" description="Run all unit test cases">
<echo message="Running tests ..."/>
description="Run all unit test cases"> </target>
<echo message="Running tests ..."/> <target name="test.lang" depends="compile.tests">
</target> <echo message="Running lang package tests ..."/>
<java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}">
<target name="test.lang" depends="compile.tests"> <arg value="org.apache.commons.lang.LangTestSuite"/>
<echo message="Running lang package tests ..."/> <classpath refid="test.classpath"/>
<java classname="${test.runner}" fork="yes" </java>
failonerror="${test.failonerror}"> </target>
<arg value="org.apache.commons.lang.LangTestSuite"/> <target name="test.builder" depends="compile.tests">
<classpath refid="test.classpath"/> <echo message="Running builder package tests ..."/>
</java> <java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}">
</target> <arg value="org.apache.commons.lang.builder.BuilderTestSuite"/>
<classpath refid="test.classpath"/>
<target name="test.builder" depends="compile.tests"> </java>
<echo message="Running builder package tests ..."/> </target>
<java classname="${test.runner}" fork="yes" <target name="test.enum" depends="compile.tests">
failonerror="${test.failonerror}"> <echo message="Running enum package tests ..."/>
<arg value="org.apache.commons.lang.builder.BuilderTestSuite"/> <java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}">
<classpath refid="test.classpath"/> <arg value="org.apache.commons.lang.enum.EnumTestSuite"/>
</java> <classpath refid="test.classpath"/>
</target> </java>
</target>
<target name="test.enum" depends="compile.tests"> <target name="test.exception" depends="compile.tests">
<echo message="Running enum package tests ..."/> <echo message="Running exception package tests ..."/>
<java classname="${test.runner}" fork="yes" <java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}">
failonerror="${test.failonerror}"> <arg value="org.apache.commons.lang.exception.ExceptionTestSuite"/>
<arg value="org.apache.commons.lang.enum.EnumTestSuite"/> <classpath refid="test.classpath"/>
<classpath refid="test.classpath"/> </java>
</java> </target>
</target> <target name="test.math" depends="compile.tests">
<echo message="Running math package tests ..."/>
<target name="test.exception" depends="compile.tests"> <java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}">
<echo message="Running exception package tests ..."/> <arg value="org.apache.commons.lang.math.MathTestSuite"/>
<java classname="${test.runner}" fork="yes" <classpath refid="test.classpath"/>
failonerror="${test.failonerror}"> </java>
<arg value="org.apache.commons.lang.exception.ExceptionTestSuite"/> </target>
<classpath refid="test.classpath"/> <target name="test.reflect" depends="compile.tests">
</java> <echo message="Running reflect package tests ..."/>
</target> <java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}">
<arg value="org.apache.commons.lang.reflect.ReflectTestSuite"/>
<target name="test.math" depends="compile.tests"> <classpath refid="test.classpath"/>
<echo message="Running math package tests ..."/> </java>
<java classname="${test.runner}" fork="yes" </target>
failonerror="${test.failonerror}"> <target name="test.time" depends="compile.tests">
<arg value="org.apache.commons.lang.math.MathTestSuite"/> <echo message="Running time package tests ..."/>
<classpath refid="test.classpath"/> <java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}">
</java> <arg value="org.apache.commons.lang.time.TimeTestSuite"/>
</target> <classpath refid="test.classpath"/>
</java>
<target name="test.reflect" depends="compile.tests"> </target>
<echo message="Running reflect package tests ..."/> <target name="test.util" depends="compile.tests">
<java classname="${test.runner}" fork="yes" <echo message="Running util package tests ..."/>
failonerror="${test.failonerror}"> <java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}">
<arg value="org.apache.commons.lang.reflect.ReflectTestSuite"/> <arg value="org.apache.commons.lang.util.UtilTestSuite"/>
<classpath refid="test.classpath"/> <classpath refid="test.classpath"/>
</java> </java>
</target> </target>
<target name="test.time" depends="compile.tests">
<echo message="Running time package tests ..."/>
<java classname="${test.runner}" fork="yes"
failonerror="${test.failonerror}">
<arg value="org.apache.commons.lang.time.TimeTestSuite"/>
<classpath refid="test.classpath"/>
</java>
</target>
<target name="test.util" depends="compile.tests">
<echo message="Running util package tests ..."/>
<java classname="${test.runner}" fork="yes"
failonerror="${test.failonerror}">
<arg value="org.apache.commons.lang.util.UtilTestSuite"/>
<classpath refid="test.classpath"/>
</java>
</target>
</project> </project>

7
src/java/org/apache/commons/lang/overview.html Normal file
View File

@ -0,0 +1,7 @@
<html>
<body>
<p>
This document is the API specification for the Apache Jakarta Commons Lang Library, version 2.0.
</p>
</body>
</html>