[slf4j-dev] svn commit: r16 - in slf4j/trunk: . src/docs src/filtered-java/org/slf4j
ceki at slf4j.org
ceki at slf4j.org
Fri Apr 22 17:53:45 CEST 2005
Author: ceki
Date: Fri Apr 22 17:53:44 2005
New Revision: 16
Added:
slf4j/trunk/src/docs/
slf4j/trunk/src/docs/overview.html
Modified:
slf4j/trunk/build.xml
slf4j/trunk/src/filtered-java/org/slf4j/LoggerFactory.java
slf4j/trunk/src/filtered-java/org/slf4j/ULogger.java
Log:
javadoc cleanup
Modified: slf4j/trunk/build.xml
==============================================================================
--- slf4j/trunk/build.xml (original)
+++ slf4j/trunk/build.xml Fri Apr 22 17:53:44 2005
@@ -1,13 +1,18 @@
<project name="slf4j" default="usage" basedir="." >
+ <!-- The build.properties file defines the path to local files -->
+ <property file="build.properties"/>
+
+ <!-- The directory where source files are stored. -->
+ <property name="version" value="1.0-beta1"/>
+
<property name="tmp.java.source.dir" value="./tmp/src"/>
<property name="tmp.javac.dest" value="./tmp/classes"/>
- <!-- The directory where source files are stored. -->
- <property name="version" value="1.0"/>
+ <property name="dist.images" value="dist/images"/>
+ <property name="dist.tmp" value="dist/tmp"/>
- <!-- Deprecation warning? -->
<property name="deprecation" value="on"/>
<property name="SLF4J_STEM" value="org/slf4j"/>
@@ -79,16 +84,16 @@
<target name="slf4j-IMPL.jar" depends="init">
<!-- delete all previously existing files in tmp -->
- <delete><fileset dir="tmp/" includes="**/*"/></delete>
+ <delete><fileset dir="tmp/" includes="**/*"/></delete>
- <!-- copy a filtered version of slf4j to tmp/src -->
- <copy todir="tmp/src">
- <fileset dir="src/filtered-java">
- <include name="**/*.java"/>
- </fileset>
- <filterset><filter token="IMPL" value="${IMPL}"/></filterset>
- </copy>
-
+ <!-- copy a filtered version of slf4j to tmp/src -->
+ <copy todir="tmp/src">
+ <fileset dir="src/filtered-java">
+ <include name="**/*.java"/>
+ </fileset>
+ <filterset><filter token="IMPL" value="${IMPL}"/></filterset>
+ </copy>
+
<javac srcdir="${tmp.java.source.dir}"
destdir="${tmp.javac.dest}"
deprecation="on"
@@ -138,4 +143,105 @@
<target name="jar" depends="slf4j-nop.jar, slf4j-simple.jar, slf4j-jdk14.jar"/>
+ <!-- Build Javadoc -->
+ <target name="javadoc" depends="init">
+
+ <!-- delete all previously existing files in tmp -->
+ <delete><fileset dir="tmp/" includes="**/*"/></delete>
+
+ <!-- copy a filtered version of slf4j to tmp/src -->
+ <copy todir="tmp/src">
+ <fileset dir="src/filtered-java">
+ <include name="**/*.java"/>
+ <include name="**/package.html"/>
+ </fileset>
+ <filterset><filter token="IMPL" value="NOP"/></filterset>
+ </copy>
+
+
+ <mkdir dir="${javadoc.dest}" />
+
+ <javadoc sourcepath="${tmp.java.source.dir}"
+ destdir="${javadoc.dest}"
+ packagenames="org.slf4j, org.slf4j.impl"
+ additionalparam="-breakiterator"
+ version="true"
+ protected="true"
+ author="true"
+ use="true"
+ overview="src/docs//overview.html"
+ doctitle="SLF4J version x ${version}"
+ windowtitle="SLF4J Version ${version}"
+ header="<b>SLF4J ${version}</b>"
+ bottom="Copyright 2004-2005
+ <a href=http://www.slf4j.org>
+ <b>SLF4J.ORG<b><a>">
+
+ <link href="http://java.sun.com/j2se/1.4.2/docs/api/"/>
+ <link href="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/"/>
+
+ </javadoc>
+ </target>
+
+
+ <target name="site">
+ <ant dir="${slf4j-site}" antfile="build.xml" target="site"/>
+ </target>
+
+ <!-- ================================================================= -->
+ <!-- Build a complete distribution. Results go to ${dist.images} -->
+ <!-- ================================================================= -->
+ <target name="dist" depends="init, clean, javadoc, jar, site">
+
+ <delete verbose="true">
+ <fileset dir=".">
+ <patternset>
+ <include name="**/*.bak"/>
+ <include name="${BSTEM}/**/temp*"/>
+ </patternset>
+ </fileset>
+ </delete>
+
+ <mkdir dir="${dist.images}" />
+
+ <mkdir dir="${dist.tmp}/slf4j-${version}" />
+
+ <copy todir="${dist.tmp}/slf4j-${version}">
+ <fileset dir="./"
+ includes="src/**,
+ build.xml,
+ build.properties.sample,
+ INSTALL.txt,
+ LICENSE.txt,
+ slf4j-*.jar"
+
+ excludes="**/*.bak,
+ **/.#*"
+ />
+ </copy>
+
+ <copy todir="${dist.tmp}/slf4j-${version}">
+ <fileset dir="${slf4j-site}/"
+ includes="docs/**"
+
+ excludes="docs/dist/**,
+ *.bak,
+ **/.#*"
+ />
+ </copy>
+
+ <tar tarfile="${dist.images}/slf4j-${version}.tar"
+ basedir="${dist.tmp}"
+ includes="slf4j-${version}/**" />
+
+ <gzip src="${dist.images}/slf4j-${version}.tar"
+ zipfile="${slf4j-site}/docs/dist/slf4j-${version}.tar.gz" />
+
+ <zip zipfile="${slf4j-site}/docs/dist/slf4j-${version}.zip"
+ basedir="${dist.tmp}"
+ includes="slf4j-${version}/**" />
+
+ <delete dir="${dist.tmp}" />
+ </target>
+
</project>
Added: slf4j/trunk/src/docs/overview.html
==============================================================================
--- (empty file)
+++ slf4j/trunk/src/docs/overview.html Fri Apr 22 17:53:44 2005
@@ -0,0 +1,13 @@
+<html>
+
+ <head>
+ <title>SLF4J overview</title>
+ </head>
+ <body>
+
+ <p>Make sure to read the <a href="../manual.html"><b>user manual</b></a>
+ in addition to this javadoc documentation.
+ </p>
+
+ </body>
+</html>
Modified: slf4j/trunk/src/filtered-java/org/slf4j/LoggerFactory.java
==============================================================================
--- slf4j/trunk/src/filtered-java/org/slf4j/LoggerFactory.java (original)
+++ slf4j/trunk/src/filtered-java/org/slf4j/LoggerFactory.java Fri Apr 22 17:53:44 2005
@@ -41,7 +41,7 @@
* The <code>LoggerFactory</code> can produce Loggers for various logging APIs,
* most notably for log4j, JDK 1.4 logging. Other implemenations such as
* {@link org.slf4j.impl.NOPLogger NOPLogger} and
- * {@link org.slf4j.impl.DumbLogger DumbLogger} are also supported.
+ * {@link org.slf4j.impl.SimpleLogger SimpleLogger} are also supported.
*
* @author Ceki Gülcü
*/
Modified: slf4j/trunk/src/filtered-java/org/slf4j/ULogger.java
==============================================================================
--- slf4j/trunk/src/filtered-java/org/slf4j/ULogger.java (original)
+++ slf4j/trunk/src/filtered-java/org/slf4j/ULogger.java Fri Apr 22 17:53:44 2005
@@ -44,7 +44,8 @@
/**
* Is the logger instance enabled for the DEBUG level?
- * @return
+ * @return True if this ULogger is enabled for the DEBUG level,
+ * false otherwise.
*/
public boolean isDebugEnabled();
More information about the slf4j-dev
mailing list