You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by rd...@apache.org on 2012/04/14 21:18:10 UTC
svn commit: r1326182 [21/43] - in
/incubator/rat/site/trunk/content/rat/whisker: ./ apache-whisker-app/
apache-whisker-app/apidocs/
apache-whisker-app/apidocs/org/apache/rat/whisker/app/
apache-whisker-app/apidocs/org/apache/rat/whisker/app/analysis/ a...
Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/VelocityReports.html
URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/VelocityReports.html?rev=1326182&r1=1326181&r2=1326182&view=diff
==============================================================================
--- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/VelocityReports.html (original)
+++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/VelocityReports.html Sat Apr 14 19:17:31 2012
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 07 13:22:40 BST 2012 -->
+<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 14 20:04:29 BST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
VelocityReports (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-04-07">
+<META NAME="date" CONTENT="2012-04-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
@@ -139,11 +139,11 @@ Wraps velocity engine.
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#VelocityReports(org.apache.rat.whisker.app.ResultWriterFactory, org.apache.commons.logging.Log)">VelocityReports</A></B>(<A HREF="http://rat.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/ResultWriterFactory.html?is-external=true" title="class or interface in org.apache.rat.whisker.app">ResultWriterFactory</A> writerFactory,
+<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#VelocityReports(org.apache.rat.whisker.app.ResultWriterFactory, org.apache.commons.logging.Log)">VelocityReports</A></B>(<A HREF="http://creadur.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/ResultWriterFactory.html?is-external=true" title="class or interface in org.apache.rat.whisker.app">ResultWriterFactory</A> writerFactory,
org.apache.commons.logging.Log log)</CODE>
<BR>
- </TD>
+ Constructs a reporter using Apache Velocity.</TD>
</TR>
</TABLE>
@@ -158,18 +158,18 @@ Wraps velocity engine.
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#generate(org.apache.rat.whisker.model.Descriptor)">generate</A></B>(<A HREF="http://rat.apache.org/whisker/apache-whisker-model/apidocs/org/apache/rat/whisker/model/Descriptor.html?is-external=true" title="class or interface in org.apache.rat.whisker.model">Descriptor</A> work)</CODE>
+<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#generate(org.apache.rat.whisker.model.Descriptor)">generate</A></B>(<A HREF="http://creadur.apache.org/whisker/apache-whisker-model/apidocs/org/apache/rat/whisker/model/Descriptor.html?is-external=true" title="class or interface in org.apache.rat.whisker.model">Descriptor</A> work)</CODE>
<BR>
- </TD>
+ Reports on work.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#generateTemplate(java.util.Collection)">generateTemplate</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://rat.apache.org/whisker/apache-whisker-scan/apidocs/org/apache/rat/whisker/scan/Directory.html?is-external=true" title="class or interface in org.apache.rat.whisker.scan">Directory</A>> withBase)</CODE>
+<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#generateTemplate(java.util.Collection)">generateTemplate</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://creadur.apache.org/whisker/apache-whisker-scan/apidocs/org/apache/rat/whisker/scan/Directory.html?is-external=true" title="class or interface in org.apache.rat.whisker.scan">Directory</A>> withBase)</CODE>
<BR>
- </TD>
+ Generates template.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -177,7 +177,7 @@ Wraps velocity engine.
<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#init(org.apache.velocity.runtime.RuntimeServices)">init</A></B>(org.apache.velocity.runtime.RuntimeServices services)</CODE>
<BR>
- </TD>
+ Unused.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -185,7 +185,7 @@ Wraps velocity engine.
<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#isLevelEnabled(int)">isLevelEnabled</A></B>(int level)</CODE>
<BR>
- </TD>
+ Indicates whether logging is enabled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -194,7 +194,7 @@ Wraps velocity engine.
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message)</CODE>
<BR>
- </TD>
+ Logs a message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -204,23 +204,23 @@ Wraps velocity engine.
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A> throwable)</CODE>
<BR>
- </TD>
+ Logs a message from Velocity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#report(java.util.Collection)">report</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://rat.apache.org/whisker/apache-whisker-scan/apidocs/org/apache/rat/whisker/scan/Directory.html?is-external=true" title="class or interface in org.apache.rat.whisker.scan">Directory</A>> directories)</CODE>
+<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#report(java.util.Collection)">report</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://creadur.apache.org/whisker/apache-whisker-scan/apidocs/org/apache/rat/whisker/scan/Directory.html?is-external=true" title="class or interface in org.apache.rat.whisker.scan">Directory</A>> directories)</CODE>
<BR>
- </TD>
+ Generates a directory report.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#validate(org.apache.rat.whisker.app.analysis.LicenseAnalyst)">validate</A></B>(<A HREF="http://rat.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/analysis/LicenseAnalyst.html?is-external=true" title="class or interface in org.apache.rat.whisker.app.analysis">LicenseAnalyst</A> analyst)</CODE>
+<TD><CODE><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html#validate(org.apache.rat.whisker.app.analysis.LicenseAnalyst)">validate</A></B>(<A HREF="http://creadur.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/analysis/LicenseAnalyst.html?is-external=true" title="class or interface in org.apache.rat.whisker.app.analysis">LicenseAnalyst</A> analyst)</CODE>
<BR>
- </TD>
+ Reports on analysis.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -248,9 +248,13 @@ Wraps velocity engine.
<A NAME="VelocityReports(org.apache.rat.whisker.app.ResultWriterFactory, org.apache.commons.logging.Log)"><!-- --></A><H3>
VelocityReports</H3>
<PRE>
-public <B>VelocityReports</B>(<A HREF="http://rat.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/ResultWriterFactory.html?is-external=true" title="class or interface in org.apache.rat.whisker.app">ResultWriterFactory</A> writerFactory,
+public <B>VelocityReports</B>(<A HREF="http://creadur.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/ResultWriterFactory.html?is-external=true" title="class or interface in org.apache.rat.whisker.app">ResultWriterFactory</A> writerFactory,
org.apache.commons.logging.Log log)</PRE>
<DL>
+<DD>Constructs a reporter using Apache Velocity.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>writerFactory</CODE> - not null<DD><CODE>log</CODE> - not null</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
@@ -266,16 +270,15 @@ public <B>VelocityReports</B>(<A HREF="h
<A NAME="init(org.apache.velocity.runtime.RuntimeServices)"><!-- --></A><H3>
init</H3>
<PRE>
-public void <B>init</B>(org.apache.velocity.runtime.RuntimeServices services)
- throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
+public final void <B>init</B>(org.apache.velocity.runtime.RuntimeServices services)</PRE>
<DL>
+<DD>Unused.
+<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>init</CODE> in interface <CODE>org.apache.velocity.runtime.log.LogChute</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE><DT><B>See Also:</B><DD><CODE>LogChute.init(org.apache.velocity.runtime.RuntimeServices)</CODE></DL>
+<DT><B>Parameters:</B><DD><CODE>services</CODE> - unused<DT><B>See Also:</B><DD><CODE>LogChute.init(RuntimeServices)</CODE></DL>
</DD>
</DL>
<HR>
@@ -283,13 +286,16 @@ public void <B>init</B>(org.apache.veloc
<A NAME="isLevelEnabled(int)"><!-- --></A><H3>
isLevelEnabled</H3>
<PRE>
-public boolean <B>isLevelEnabled</B>(int level)</PRE>
+public final boolean <B>isLevelEnabled</B>(int level)</PRE>
<DL>
+<DD>Indicates whether logging is enabled.
+<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isLevelEnabled</CODE> in interface <CODE>org.apache.velocity.runtime.log.LogChute</CODE></DL>
</DD>
<DD><DL>
-<DT><B>See Also:</B><DD><CODE>LogChute.isLevelEnabled(int)</CODE></DL>
+<DT><B>Parameters:</B><DD><CODE>level</CODE> - at this level
+<DT><B>Returns:</B><DD>true when log level is enabled, false otherwise<DT><B>See Also:</B><DD><CODE>LogChute.isLevelEnabled(int)</CODE></DL>
</DD>
</DL>
<HR>
@@ -297,14 +303,16 @@ public boolean <B>isLevelEnabled</B>(int
<A NAME="log(int, java.lang.String)"><!-- --></A><H3>
log</H3>
<PRE>
-public void <B>log</B>(int level,
- <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message)</PRE>
+public final void <B>log</B>(int level,
+ <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message)</PRE>
<DL>
+<DD>Logs a message.
+<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>log</CODE> in interface <CODE>org.apache.velocity.runtime.log.LogChute</CODE></DL>
</DD>
<DD><DL>
-<DT><B>See Also:</B><DD><CODE>LogChute.log(int, java.lang.String)</CODE></DL>
+<DT><B>Parameters:</B><DD><CODE>level</CODE> - at level<DD><CODE>message</CODE> - possibly null<DT><B>See Also:</B><DD><CODE>LogChute.log(int, String)</CODE></DL>
</DD>
</DL>
<HR>
@@ -312,15 +320,17 @@ public void <B>log</B>(int level,
<A NAME="log(int, java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
log</H3>
<PRE>
-public void <B>log</B>(int level,
- <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message,
- <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A> throwable)</PRE>
+public final void <B>log</B>(int level,
+ <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message,
+ <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A> throwable)</PRE>
<DL>
+<DD>Logs a message from Velocity.
+<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>log</CODE> in interface <CODE>org.apache.velocity.runtime.log.LogChute</CODE></DL>
</DD>
<DD><DL>
-<DT><B>See Also:</B><DD><CODE>LogChute.log(int, java.lang.String, java.lang.Throwable)</CODE></DL>
+<DT><B>Parameters:</B><DD><CODE>level</CODE> - log level<DD><CODE>message</CODE> - possibly null<DD><CODE>throwable</CODE> - possibly null<DT><B>See Also:</B><DD><CODE>LogChute.log(int, String, Throwable)</CODE></DL>
</DD>
</DL>
<HR>
@@ -328,16 +338,18 @@ public void <B>log</B>(int level,
<A NAME="generate(org.apache.rat.whisker.model.Descriptor)"><!-- --></A><H3>
generate</H3>
<PRE>
-public void <B>generate</B>(<A HREF="http://rat.apache.org/whisker/apache-whisker-model/apidocs/org/apache/rat/whisker/model/Descriptor.html?is-external=true" title="class or interface in org.apache.rat.whisker.model">Descriptor</A> work)
- throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
+public final void <B>generate</B>(<A HREF="http://creadur.apache.org/whisker/apache-whisker-model/apidocs/org/apache/rat/whisker/model/Descriptor.html?is-external=true" title="class or interface in org.apache.rat.whisker.model">Descriptor</A> work)
+ throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
+<DD>Reports on work.
+<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-
+<DT><B>Parameters:</B><DD><CODE>work</CODE> - not null
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - when generation fails</DL>
</DD>
</DL>
<HR>
@@ -345,16 +357,18 @@ public void <B>generate</B>(<A HREF="htt
<A NAME="report(java.util.Collection)"><!-- --></A><H3>
report</H3>
<PRE>
-public void <B>report</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://rat.apache.org/whisker/apache-whisker-scan/apidocs/org/apache/rat/whisker/scan/Directory.html?is-external=true" title="class or interface in org.apache.rat.whisker.scan">Directory</A>> directories)
- throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
+public final void <B>report</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://creadur.apache.org/whisker/apache-whisker-scan/apidocs/org/apache/rat/whisker/scan/Directory.html?is-external=true" title="class or interface in org.apache.rat.whisker.scan">Directory</A>> directories)
+ throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
+<DD>Generates a directory report.
+<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-
+<DT><B>Parameters:</B><DD><CODE>directories</CODE> - not null
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - when reporting fails</DL>
</DD>
</DL>
<HR>
@@ -362,16 +376,18 @@ public void <B>report</B>(<A HREF="http:
<A NAME="validate(org.apache.rat.whisker.app.analysis.LicenseAnalyst)"><!-- --></A><H3>
validate</H3>
<PRE>
-public void <B>validate</B>(<A HREF="http://rat.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/analysis/LicenseAnalyst.html?is-external=true" title="class or interface in org.apache.rat.whisker.app.analysis">LicenseAnalyst</A> analyst)
- throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
+public final void <B>validate</B>(<A HREF="http://creadur.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/analysis/LicenseAnalyst.html?is-external=true" title="class or interface in org.apache.rat.whisker.app.analysis">LicenseAnalyst</A> analyst)
+ throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
+<DD>Reports on analysis.
+<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>licenseDescriptor</CODE> - <DD><CODE>withBase</CODE> -
+<DT><B>Parameters:</B><DD><CODE>analyst</CODE> - not null
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - when validation fails</DL>
</DD>
</DL>
<HR>
@@ -379,21 +395,18 @@ public void <B>validate</B>(<A HREF="htt
<A NAME="generateTemplate(java.util.Collection)"><!-- --></A><H3>
generateTemplate</H3>
<PRE>
-public void <B>generateTemplate</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://rat.apache.org/whisker/apache-whisker-scan/apidocs/org/apache/rat/whisker/scan/Directory.html?is-external=true" title="class or interface in org.apache.rat.whisker.scan">Directory</A>> withBase)
- throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
+public final void <B>generateTemplate</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://creadur.apache.org/whisker/apache-whisker-scan/apidocs/org/apache/rat/whisker/scan/Directory.html?is-external=true" title="class or interface in org.apache.rat.whisker.scan">Directory</A>> withBase)
+ throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
+<DD>Generates template.
+<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>withBase</CODE> -
+<DT><B>Parameters:</B><DD><CODE>withBase</CODE> - not null
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE>
-<DD><CODE>JDOMException</CODE>
-<DD><CODE>org.apache.velocity.exception.MethodInvocationException</CODE>
-<DD><CODE>org.apache.velocity.exception.ParseErrorException</CODE>
-<DD><CODE>org.apache.velocity.exception.ResourceNotFoundException</CODE>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - when generation fails</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/Indentation.html
URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/Indentation.html?rev=1326182&r1=1326181&r2=1326182&view=diff
==============================================================================
--- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/Indentation.html (original)
+++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/Indentation.html Sat Apr 14 19:17:31 2012
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 07 13:22:40 BST 2012 -->
+<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 14 20:04:30 BST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
Uses of Class org.apache.rat.whisker.out.velocity.Indentation (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-04-07">
+<META NAME="date" CONTENT="2012-04-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/Product.html
URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/Product.html?rev=1326182&r1=1326181&r2=1326182&view=diff
==============================================================================
--- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/Product.html (original)
+++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/Product.html Sat Apr 14 19:17:31 2012
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 07 13:22:40 BST 2012 -->
+<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 14 20:04:30 BST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
Uses of Class org.apache.rat.whisker.out.velocity.Product (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-04-07">
+<META NAME="date" CONTENT="2012-04-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/VelocityEngine.html
URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/VelocityEngine.html?rev=1326182&r1=1326181&r2=1326182&view=diff
==============================================================================
--- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/VelocityEngine.html (original)
+++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/VelocityEngine.html Sat Apr 14 19:17:31 2012
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 07 13:22:40 BST 2012 -->
+<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 14 20:04:30 BST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
Uses of Class org.apache.rat.whisker.out.velocity.VelocityEngine (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-04-07">
+<META NAME="date" CONTENT="2012-04-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/VelocityReports.html
URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/VelocityReports.html?rev=1326182&r1=1326181&r2=1326182&view=diff
==============================================================================
--- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/VelocityReports.html (original)
+++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/class-use/VelocityReports.html Sat Apr 14 19:17:31 2012
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 07 13:22:40 BST 2012 -->
+<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 14 20:04:30 BST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
Uses of Class org.apache.rat.whisker.out.velocity.VelocityReports (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-04-07">
+<META NAME="date" CONTENT="2012-04-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-frame.html?rev=1326182&r1=1326181&r2=1326182&view=diff
==============================================================================
--- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-frame.html (original)
+++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-frame.html Sat Apr 14 19:17:31 2012
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 07 13:22:40 BST 2012 -->
+<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 14 20:04:29 BST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
org.apache.rat.whisker.out.velocity (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-04-07">
+<META NAME="date" CONTENT="2012-04-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-summary.html?rev=1326182&r1=1326181&r2=1326182&view=diff
==============================================================================
--- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-summary.html (original)
+++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-summary.html Sat Apr 14 19:17:31 2012
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 07 13:22:40 BST 2012 -->
+<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 14 20:04:29 BST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
org.apache.rat.whisker.out.velocity (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-04-07">
+<META NAME="date" CONTENT="2012-04-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
@@ -82,6 +82,13 @@ function windowTitle()
<H2>
Package org.apache.rat.whisker.out.velocity
</H2>
+Uses <a href='http://velocity.apache.org'>Apache Velocity</a>
+ templating engine to generate reports.
+<P>
+<B>See:</B>
+<BR>
+ <A HREF="#package_description"><B>Description</B></A>
+<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
@@ -90,11 +97,11 @@ Package org.apache.rat.whisker.out.veloc
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/Indentation.html" title="class in org.apache.rat.whisker.out.velocity">Indentation</A></B></TD>
-<TD> </TD>
+<TD>Manages indentation level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityEngine.html" title="class in org.apache.rat.whisker.out.velocity">VelocityEngine</A></B></TD>
-<TD> </TD>
+<TD>Uses Apache Velocity to implement <A HREF="http://creadur.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/AbstractEngine.html?is-external=true" title="class or interface in org.apache.rat.whisker.app"><CODE>AbstractEngine</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html" title="class in org.apache.rat.whisker.out.velocity">VelocityReports</A></B></TD>
@@ -118,6 +125,16 @@ Package org.apache.rat.whisker.out.veloc
<P>
+<A NAME="package_description"><!-- --></A><H2>
+Package org.apache.rat.whisker.out.velocity Description
+</H2>
+
+<P>
+Uses <a href='http://velocity.apache.org'>Apache Velocity</a>
+ templating engine to generate reports.
+<P>
+
+<P>
<DL>
</DL>
<HR>
Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-tree.html?rev=1326182&r1=1326181&r2=1326182&view=diff
==============================================================================
--- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-tree.html (original)
+++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-tree.html Sat Apr 14 19:17:31 2012
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 07 13:22:40 BST 2012 -->
+<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 14 20:04:29 BST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
org.apache.rat.whisker.out.velocity Class Hierarchy (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-04-07">
+<META NAME="date" CONTENT="2012-04-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
@@ -89,7 +89,7 @@ Class Hierarchy
</H2>
<UL>
<LI TYPE="circle">java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><B>Object</B></A><UL>
-<LI TYPE="circle">org.apache.rat.whisker.app.<A HREF="http://rat.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/AbstractEngine.html?is-external=true" title="class or interface in org.apache.rat.whisker.app"><B>AbstractEngine</B></A><UL>
+<LI TYPE="circle">org.apache.rat.whisker.app.<A HREF="http://creadur.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/AbstractEngine.html?is-external=true" title="class or interface in org.apache.rat.whisker.app"><B>AbstractEngine</B></A><UL>
<LI TYPE="circle">org.apache.rat.whisker.out.velocity.<A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityEngine.html" title="class in org.apache.rat.whisker.out.velocity"><B>VelocityEngine</B></A></UL>
<LI TYPE="circle">org.apache.rat.whisker.out.velocity.<A HREF="../../../../../../org/apache/rat/whisker/out/velocity/Indentation.html" title="class in org.apache.rat.whisker.out.velocity"><B>Indentation</B></A><LI TYPE="circle">org.apache.rat.whisker.out.velocity.<A HREF="../../../../../../org/apache/rat/whisker/out/velocity/VelocityReports.html" title="class in org.apache.rat.whisker.out.velocity"><B>VelocityReports</B></A> (implements org.apache.velocity.runtime.log.LogChute)
</UL>
Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-use.html
URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-use.html?rev=1326182&r1=1326181&r2=1326182&view=diff
==============================================================================
--- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-use.html (original)
+++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/package-use.html Sat Apr 14 19:17:31 2012
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 07 13:22:40 BST 2012 -->
+<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 14 20:04:30 BST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
Uses of Package org.apache.rat.whisker.out.velocity (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-04-07">
+<META NAME="date" CONTENT="2012-04-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/overview-tree.html
URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/overview-tree.html?rev=1326182&r1=1326181&r2=1326182&view=diff
==============================================================================
--- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/overview-tree.html (original)
+++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/overview-tree.html Sat Apr 14 19:17:31 2012
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 07 13:22:40 BST 2012 -->
+<!-- Generated by javadoc (build 1.6.0_24) on Sat Apr 14 20:04:30 BST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
Class Hierarchy (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-04-07">
+<META NAME="date" CONTENT="2012-04-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -91,7 +91,7 @@ Class Hierarchy
</H2>
<UL>
<LI TYPE="circle">java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><B>Object</B></A><UL>
-<LI TYPE="circle">org.apache.rat.whisker.app.<A HREF="http://rat.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/AbstractEngine.html?is-external=true" title="class or interface in org.apache.rat.whisker.app"><B>AbstractEngine</B></A><UL>
+<LI TYPE="circle">org.apache.rat.whisker.app.<A HREF="http://creadur.apache.org/whisker/apache-whisker-app/apidocs/org/apache/rat/whisker/app/AbstractEngine.html?is-external=true" title="class or interface in org.apache.rat.whisker.app"><B>AbstractEngine</B></A><UL>
<LI TYPE="circle">org.apache.rat.whisker.out.velocity.<A HREF="org/apache/rat/whisker/out/velocity/VelocityEngine.html" title="class in org.apache.rat.whisker.out.velocity"><B>VelocityEngine</B></A></UL>
<LI TYPE="circle">org.apache.rat.whisker.out.velocity.<A HREF="org/apache/rat/whisker/out/velocity/Indentation.html" title="class in org.apache.rat.whisker.out.velocity"><B>Indentation</B></A><LI TYPE="circle">org.apache.rat.whisker.out.velocity.<A HREF="org/apache/rat/whisker/out/velocity/VelocityReports.html" title="class in org.apache.rat.whisker.out.velocity"><B>VelocityReports</B></A> (implements org.apache.velocity.runtime.log.LogChute)
</UL>