Return-Path: X-Original-To: apmail-incubator-rat-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-rat-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 127BF917B for ; Sun, 15 Apr 2012 20:11:46 +0000 (UTC) Received: (qmail 16036 invoked by uid 500); 15 Apr 2012 20:11:45 -0000 Delivered-To: apmail-incubator-rat-commits-archive@incubator.apache.org Received: (qmail 16009 invoked by uid 500); 15 Apr 2012 20:11:45 -0000 Mailing-List: contact rat-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: rat-dev@incubator.apache.org Delivered-To: mailing list rat-commits@incubator.apache.org Received: (qmail 16002 invoked by uid 99); 15 Apr 2012 20:11:45 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 15 Apr 2012 20:11:45 +0000 X-ASF-Spam-Status: No, hits=-1996.5 required=5.0 tests=ALL_TRUSTED,URIBL_BLACK X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 15 Apr 2012 20:11:07 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 7739C2388C74; Sun, 15 Apr 2012 20:09:25 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1326182 [20/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... Date: Sun, 15 Apr 2012 20:08:46 -0000 To: rat-commits@incubator.apache.org From: rdonkin@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120415200925.7739C2388C74@eris.apache.org> Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-scan/taglist.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-scan/taglist.html?rev=1326182&r1=1326181&r2=1326182&view=diff ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-scan/taglist.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-scan/taglist.html Sat Apr 14 19:17:31 2012 @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -27,7 +27,7 @@
- Last Published: 2012-04-07 + Last Published: 2012-04-14  | Version: 0.1-SNAPSHOT
@@ -47,6 +47,12 @@ Introduction +
Parent Project
+
Project Documentation
-

Tag List Report

The following document contains the listing of user tags found in the code. Below is the summary of the occurrences per tag.

Each tag is detailed below:

TODO

Number of occurrences found in the code: 1

Tag ClassTotal number of occurrencesTag strings used by tag class
@deprecated0@deprecated
@todo0@todo
FIXME0FIXME
REFACTOR0REFACTOR
REVIEW0REVIEW
TODO1TODO
fixme0fixme
refactor0refactor
review0review
todo0todo
org.apache.rat.whisker.scan.FromFileSystemLine
wait until all threads done86
+

Tag List Report

The following document contains the listing of user tags found in the code. Below is the summary of the occurrences per tag.

Tag ClassTotal number of occurrencesTag strings used by tag class
@deprecated0@deprecated
@todo0@todo
FIXME0FIXME
REFACTOR0REFACTOR
REVIEW0REVIEW
TODO0TODO
fixme0fixme
refactor0refactor
review0review
todo0todo

Each tag is detailed be low:

Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-scan/team-list.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-scan/team-list.html?rev=1326182&r1=1326181&r2=1326182&view=diff ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-scan/team-list.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-scan/team-list.html Sat Apr 14 19:17:31 2012 @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -27,7 +27,7 @@
- Last Published: 2012-04-07 + Last Published: 2012-04-14  | Version: 0.1-SNAPSHOT
@@ -47,6 +47,12 @@ Introduction +
Parent Project
+
Project Documentation
  • Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/allclasses-frame.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/allclasses-frame.html?rev=1326182&r1=1326181&r2=1326182&view=diff ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/allclasses-frame.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/allclasses-frame.html Sat Apr 14 19:17:31 2012 @@ -2,13 +2,13 @@ - + All Classes (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API) - + Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/allclasses-noframe.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/allclasses-noframe.html?rev=1326182&r1=1326181&r2=1326182&view=diff ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/allclasses-noframe.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/allclasses-noframe.html Sat Apr 14 19:17:31 2012 @@ -2,13 +2,13 @@ - + All Classes (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API) - + Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/constant-values.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/constant-values.html?rev=1326182&r1=1326181&r2=1326182&view=diff ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/constant-values.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/constant-values.html Sat Apr 14 19:17:31 2012 @@ -2,13 +2,13 @@ - + Constant Field Values (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API) - + Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/deprecated-list.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/deprecated-list.html?rev=1326182&r1=1326181&r2=1326182&view=diff ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/deprecated-list.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/deprecated-list.html Sat Apr 14 19:17:31 2012 @@ -2,13 +2,13 @@ - + Deprecated List (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API) - + Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/help-doc.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/help-doc.html?rev=1326182&r1=1326181&r2=1326182&view=diff ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/help-doc.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/help-doc.html Sat Apr 14 19:17:31 2012 @@ -2,13 +2,13 @@ - + API Help (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API) - + Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/index-all.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/index-all.html?rev=1326182&r1=1326181&r2=1326182&view=diff ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/index-all.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/index-all.html Sat Apr 14 19:17:31 2012 @@ -2,13 +2,13 @@ - + Index (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API) - + @@ -84,16 +84,16 @@ function windowTitle()
    generate(Descriptor, ResultWriterFactory) - Method in class org.apache.rat.whisker.out.velocity.VelocityEngine -
      +
    Generates documents, and writes results using given factory.
    generate(Descriptor) - Method in class org.apache.rat.whisker.out.velocity.VelocityReports -
      +
    Reports on work.
    generateTemplate(Collection<Directory>, ResultWriterFactory) - Method in class org.apache.rat.whisker.out.velocity.VelocityEngine -
      +
    Generates a template, and writes result using given factory.
    generateTemplate(Collection<Directory>) - Method in class org.apache.rat.whisker.out.velocity.VelocityReports -
      +
    Generates template.
    getResult() - Method in enum org.apache.rat.whisker.out.velocity.Product
    Gets result implemented by this product. @@ -107,19 +107,19 @@ Method in enum org.apache.rat.whisker.ou
    indent(int, Object) - Method in class org.apache.rat.whisker.out.velocity.Indentation -
      +
    Creates appropriate indentation, padding with spaces.
    indent(int, Object, char) - Method in class org.apache.rat.whisker.out.velocity.Indentation -
      -
    Indentation - Class in org.apache.rat.whisker.out.velocity
     
    Indentation() - +
    Creates appropriate indentation. +
    Indentation - Class in org.apache.rat.whisker.out.velocity
    Manages indentation level.
    Indentation() - Constructor for class org.apache.rat.whisker.out.velocity.Indentation
     
    init(RuntimeServices) - Method in class org.apache.rat.whisker.out.velocity.VelocityReports -
      +
    Unused.
    isLevelEnabled(int) - Method in class org.apache.rat.whisker.out.velocity.VelocityReports -
      +
    Indicates whether logging is enabled.

    @@ -127,16 +127,17 @@ Method in class org.apache.rat.whisker.o
    log(int, String) - Method in class org.apache.rat.whisker.out.velocity.VelocityReports -
      +
    Logs a message.
    log(int, String, Throwable) - Method in class org.apache.rat.whisker.out.velocity.VelocityReports -
      +
    Logs a message from Velocity.

    O

    -
    org.apache.rat.whisker.out.velocity - package org.apache.rat.whisker.out.velocity
     
    +
    org.apache.rat.whisker.out.velocity - package org.apache.rat.whisker.out.velocity
    Uses Apache Velocity + templating engine to generate reports.

    P

    @@ -148,10 +149,10 @@ Method in class org.apache.rat.whisker.o
    report(Collection<Directory>, ResultWriterFactory) - Method in class org.apache.rat.whisker.out.velocity.VelocityEngine -
      +
    Generates a directories report, and writes result using given factory.
    report(Collection<Directory>) - Method in class org.apache.rat.whisker.out.velocity.VelocityReports -
      +
    Generates a directory report.

    @@ -159,10 +160,10 @@ Method in class org.apache.rat.whisker.o
    validate(LicenseAnalyst, ResultWriterFactory) - Method in class org.apache.rat.whisker.out.velocity.VelocityEngine -
      +
    Generates a validation report, and writes result using given factory.
    validate(LicenseAnalyst) - Method in class org.apache.rat.whisker.out.velocity.VelocityReports -
      +
    Reports on analysis.
    valueOf(String) - Static method in enum org.apache.rat.whisker.out.velocity.Product
    Returns the enum constant of this type with the specified name. @@ -170,12 +171,12 @@ Static method in enum org.apache.rat.whi Static method in enum org.apache.rat.whisker.out.velocity.Product
    Returns an array containing the constants of this enum type, in the order they are declared. -
    VelocityEngine - Class in org.apache.rat.whisker.out.velocity
     
    VelocityEngine(Log) - +
    VelocityEngine - Class in org.apache.rat.whisker.out.velocity
    Uses Apache Velocity to implement AbstractEngine.
    VelocityEngine(Log) - Constructor for class org.apache.rat.whisker.out.velocity.VelocityEngine -
      +
    Constructs an engine running on Apache Velocity.
    VelocityReports - Class in org.apache.rat.whisker.out.velocity
    Wraps velocity engine.
    VelocityReports(ResultWriterFactory, Log) - Constructor for class org.apache.rat.whisker.out.velocity.VelocityReports -
      +
    Constructs a reporter using Apache Velocity.

    Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/index.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/index.html?rev=1326182&r1=1326181&r2=1326182&view=diff ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/index.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/index.html Sat Apr 14 19:17:31 2012 @@ -2,7 +2,7 @@ - + Apache Whisker::Output(velocity) 0.1-SNAPSHOT API Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/options URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/options?rev=1326182&r1=1326181&r2=1326182&view=diff ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/options (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/options Sat Apr 14 19:17:31 2012 @@ -1,5 +1,5 @@ -classpath -'/opt/development/2011/rat/whisker/apache-whisker-velocity/target/classes:/home/rob/.m2/repository/org/apache/velocity/velocity/1.7/velocity-1.7.jar:/home/rob/.m2/repository/commons-io/commons-io/2.1/commons-io-2.1.jar:/opt/development/2011/rat/whisker/apache-whisker-app/target/apache-whisker-app-0.1-SNAPSHOT.jar:/home/rob/.m2/repository/commons-lang/commons-lang/2.4/commons-lang-2.4.jar:/opt/development/2011/rat/whisker/apache-whisker-scan/target/apache-whisker-scan-0.1-SNAPSHOT.jar:/home/rob/.m2/repository/org/apache/commons/commons-lang3/3.0/commons-lang3-3.0.jar:/home/rob/.m2/repository/commons-logging/commons-logging-api/1.1/commons-logging-api-1.1.jar:/home/rob/.m2/repository/commons-collections/commons-collections/3.2.1/commons-collections-3.2.1.jar:/home/rob/.m2/repository/org/jdom/jdom/1.1/jdom-1.1.jar:/opt/development/2011/rat/whisker/apache-whisker-xml/target/apache-whisker-xml-0.1-SNAPSHOT.jar:/opt/development/2011/rat/whisker/apache-whisker-model/target/apache-w hisker-model-0.1-SNAPSHOT.jar' +'/opt/development/2011/rat/whisker/apache-whisker-velocity/target/classes:/home/rob/.m2/repository/org/apache/velocity/velocity/1.7/velocity-1.7.jar:/opt/development/2011/rat/whisker/apache-whisker-model/target/classes:/home/rob/.m2/repository/commons-io/commons-io/2.1/commons-io-2.1.jar:/opt/development/2011/rat/whisker/apache-whisker-xml/target/classes:/home/rob/.m2/repository/commons-lang/commons-lang/2.4/commons-lang-2.4.jar:/opt/development/2011/rat/whisker/apache-whisker-app/target/classes:/home/rob/.m2/repository/org/apache/commons/commons-lang3/3.0/commons-lang3-3.0.jar:/home/rob/.m2/repository/commons-logging/commons-logging-api/1.1/commons-logging-api-1.1.jar:/home/rob/.m2/repository/commons-collections/commons-collections/3.2.1/commons-collections-3.2.1.jar:/opt/development/2011/rat/whisker/apache-whisker-scan/target/classes:/home/rob/.m2/repository/org/jdom/jdom/1.1/jdom-1.1.jar' -encoding 'UTF-8' -protected @@ -19,11 +19,11 @@ -linkoffline 'http://download.oracle.com/javase/1.5.0/docs/api' '/opt/development/2011/rat/whisker/apache-whisker-velocity/target/javadoc-bundle-options' -linkoffline -'http://rat.apache.org/whisker/apache-whisker-model/apidocs' '/opt/development/2011/rat/whisker/apache-whisker-model/target/site/apidocs' +'http://creadur.apache.org/whisker/apache-whisker-model/apidocs' '/opt/development/2011/rat/whisker/apache-whisker-model/target/site/apidocs' -linkoffline -'http://rat.apache.org/whisker/apache-whisker-scan/apidocs' '/opt/development/2011/rat/whisker/apache-whisker-scan/target/site/apidocs' +'http://creadur.apache.org/whisker/apache-whisker-scan/apidocs' '/opt/development/2011/rat/whisker/apache-whisker-scan/target/site/apidocs' -linkoffline -'http://rat.apache.org/whisker/apache-whisker-app/apidocs' '/opt/development/2011/rat/whisker/apache-whisker-app/target/site/apidocs' +'http://creadur.apache.org/whisker/apache-whisker-app/apidocs' '/opt/development/2011/rat/whisker/apache-whisker-app/target/site/apidocs' -use -version -windowtitle Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/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/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/Indentation.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/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:39 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> Indentation (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API) - + @@ -101,6 +101,10 @@ Class Indentation

    +Manages indentation level. +

    + +

    @@ -136,7 +140,7 @@ Class Indentation Object source)
    -            +          Creates appropriate indentation, padding with spaces. @@ -146,7 +150,7 @@ Class Indentation char pad)
    -            +          Creates appropriate indentation.   @@ -191,14 +195,17 @@ public Indentation()

    indent

    -public String indent(int indentation,
-                     Object source)
-              throws IOException
    +public final String indent(int indentation, + Object source) + throws IOException
    +
    Creates appropriate indentation, padding with spaces. +

    - +
    Parameters:
    indentation - not null
    source - not null +
    Returns:
    appropriate indentation, not null
    Throws: -
    IOException
    +
    IOException - when source cannot be read
    @@ -206,15 +213,18 @@ public

    indent

    -public String indent(int indentation,
-                     Object source,
-                     char pad)
-              throws IOException
    +public final String indent(int indentation, + Object source, + char pad) + throws IOException
    +
    Creates appropriate indentation. +

    - +
    Parameters:
    indentation - not null
    source - not null
    pad - padding +
    Returns:
    appropriate indentation, not null
    Throws: -
    IOException
    +
    IOException - when source cannot be read
    Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/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/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/Product.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/Product.html Sat Apr 14 19:17:31 2012 @@ -2,13 +2,13 @@ - + Product (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API) - + @@ -124,31 +124,31 @@ Products generated by velocity templates DIRECTORIES_REPORT_TEMPLATE
    -            +          Produces a directories report. LICENSE
    -            +          Produces a LICENSE report. MISSING_LICENSE_REPORT_TEMPLATE
    -            +          Produces a missing license report. NOTICE
    -            +          Produces a NOTICE report. XML_TEMPLATE
    -            +          Produces an xml template.   @@ -162,7 +162,7 @@ Products generated by velocity templates - Result + Result     getResult()
    @@ -196,7 +196,7 @@ the order they are declared.  Writer -writerFrom(ResultWriterFactory writerFactory) +writerFrom(ResultWriterFactory writerFactory)
              Builds writer for this product. @@ -238,6 +238,8 @@ NOTICE 
     public static final Product NOTICE
    +
    Produces a NOTICE report. +

    @@ -248,6 +250,8 @@ LICENSE 
     public static final Product LICENSE
    +
    Produces a LICENSE report. +

    @@ -258,6 +262,8 @@ DIRECTORIES_REPORT_TEMPLATE 
     public static final Product DIRECTORIES_REPORT_TEMPLATE
    +
    Produces a directories report. +

    @@ -268,6 +274,8 @@ MISSING_LICENSE_REPORT_TEMPLATE 
     public static final Product MISSING_LICENSE_REPORT_TEMPLATE
    +
    Produces a missing license report. +

    @@ -278,6 +286,8 @@ XML_TEMPLATE 
     public static final Product XML_TEMPLATE
    +
    Produces an xml template. +

    @@ -351,7 +361,7 @@ public

    getResult

    -public Result getResult()
    +public Result getResult()
    Gets result implemented by this product.

    @@ -365,7 +375,7 @@ public

    writerFrom

    -public Writer writerFrom(ResultWriterFactory writerFactory)
+public Writer writerFrom(ResultWriterFactory writerFactory)
                   throws IOException
    Builds writer for this product. @@ -374,7 +384,7 @@ public IOException
    +
    IOException - when write fails
    Modified: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/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/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/VelocityEngine.html (original) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-velocity/apidocs/org/apache/rat/whisker/out/velocity/VelocityEngine.html Sat Apr 14 19:17:31 2012 @@ -2,13 +2,13 @@ - + VelocityEngine (Apache Whisker::Output(velocity) 0.1-SNAPSHOT API) - + @@ -93,15 +93,21 @@ org.apache.rat.whisker.out.velocity 
     java.lang.Object
-  extended by org.apache.rat.whisker.app.AbstractEngine
+  extended by org.apache.rat.whisker.app.AbstractEngine
       extended by org.apache.rat.whisker.out.velocity.VelocityEngine
    -
    public class VelocityEngine
    extends AbstractEngine
    +
    public class VelocityEngine
    extends AbstractEngine

    +Uses Apache Velocity to implement AbstractEngine. +

    + +

    +

    +
    See Also:
    Apache Velocity

    @@ -118,7 +124,7 @@ Class VelocityEngine VelocityEngine(org.apache.commons.logging.Log log)
    -            +          Constructs an engine running on Apache Velocity.   @@ -132,39 +138,39 @@ Class VelocityEngine - AbstractEngine -generate(Descriptor work, - ResultWriterFactory writerFactory) + AbstractEngine +generate(Descriptor work, + ResultWriterFactory writerFactory)
    -            +          Generates documents, and writes results using given factory. - AbstractEngine -generateTemplate(Collection<Directory> withBase, - ResultWriterFactory writerFactory) + AbstractEngine +generateTemplate(Collection<Directory> withBase, + ResultWriterFactory writerFactory)
    -            +          Generates a template, and writes result using given factory. - AbstractEngine -report(Collection<Directory> directories, - ResultWriterFactory writerFactory) + AbstractEngine +report(Collection<Directory> directories, + ResultWriterFactory writerFactory)
    -            +          Generates a directories report, and writes result using given factory. - AbstractEngine -validate(LicenseAnalyst analyst, - ResultWriterFactory writerFactory) + AbstractEngine +validate(LicenseAnalyst analyst, + ResultWriterFactory writerFactory)
    -            +          Generates a validation report, and writes result using given factory.   @@ -194,6 +200,10 @@ VelocityEngine 

     public VelocityEngine(org.apache.commons.logging.Log log)
    +
    Constructs an engine running on Apache Velocity. +

    +

    +
    Parameters:
    log - not null
    @@ -209,17 +219,21 @@ public VelocityEngine(org.apache.

    generateTemplate

    -public AbstractEngine generateTemplate(Collection<Directory> withBase,
-                                       ResultWriterFactory writerFactory)
-                                throws Exception
    +public final AbstractEngine generateTemplate(Collection<Directory> withBase, + ResultWriterFactory writerFactory) + throws Exception
    +
    Generates a template, and writes result using given factory. +

    -
    Specified by:
    generateTemplate in class AbstractEngine
    +
    Specified by:
    generateTemplate in class AbstractEngine
    - +
    Parameters:
    withBase - not null
    writerFactory - not null +
    Returns:
    this engine, not null
    Throws: -
    Exception
    See Also:
    AbstractEngine.generateTemplate(java.util.Collection, ResultWriterFactory)
    +
    Exception - when generation fails
    See Also:
    AbstractEngine.generateTemplate( + java.util.Collection, ResultWriterFactory)
    @@ -227,17 +241,20 @@ public

    validate

    -public AbstractEngine validate(LicenseAnalyst analyst,
-                               ResultWriterFactory writerFactory)
-                        throws Exception
    +public final AbstractEngine validate(LicenseAnalyst analyst, + ResultWriterFactory writerFactory) + throws Exception
    +
    Generates a validation report, and writes result using given factory. +

    -
    Specified by:
    validate in class AbstractEngine
    +
    Specified by:
    validate in class AbstractEngine
    - +
    Parameters:
    analyst - not null
    writerFactory - not null +
    Returns:
    this, not null
    Throws: -
    Exception
    See Also:
    org.apache.rat.whisker.app.AbstractEngine#validate(org.apache.rat.whisker.app.LicenseAnalyst, ResultWriterFactory)
    +
    Exception - when validation fails
    See Also:
    AbstractEngine.validate(LicenseAnalyst, ResultWriterFactory)
    @@ -245,17 +262,20 @@ public

    report

    -public AbstractEngine report(Collection<Directory> directories,
-                             ResultWriterFactory writerFactory)
-                      throws Exception
    +public final AbstractEngine report(Collection<Directory> directories, + ResultWriterFactory writerFactory) + throws Exception
    +
    Generates a directories report, and writes result using given factory. +

    -
    Specified by:
    report in class AbstractEngine
    +
    Specified by:
    report in class AbstractEngine
    - +
    Parameters:
    directories - not null
    writerFactory - not null +
    Returns:
    this, not null
    Throws: -
    Exception
    See Also:
    AbstractEngine.report(java.util.Collection, ResultWriterFactory)
    +
    Exception - when reporting fails
    See Also:
    AbstractEngine.report(java.util.Collection, ResultWriterFactory)
    @@ -263,17 +283,20 @@ public

    generate

    -public AbstractEngine generate(Descriptor work,
-                               ResultWriterFactory writerFactory)
-                        throws Exception
    +public final AbstractEngine generate(Descriptor work, + ResultWriterFactory writerFactory) + throws Exception
    +
    Generates documents, and writes results using given factory. +

    -
    Specified by:
    generate in class AbstractEngine
    +
    Specified by:
    generate in class AbstractEngine
    - +
    Parameters:
    work - not null
    writerFactory - not null +
    Returns:
    this, not null
    Throws: -
    Exception
    See Also:
    AbstractEngine.generate(org.apache.rat.whisker.model.Descriptor, ResultWriterFactory)
    +
    Exception - when generation fails.
    See Also:
    AbstractEngine.generate(Descriptor, ResultWriterFactory)