Class Exporter

java.lang.Object

org.apache.rat.documentation.Exporter

public class Exporter
extends Object

Uses Apache Velocity to write a document containing RAT configuration information.

See Also:

• Apache Velocity

Constructor Summary

Constructors

Constructor	Description
Exporter()

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)	Executes the generation of documentation from a configuration definition.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Exporter

public Exporter()

Method Details

toString

public String toString()

Overrides:

toString in class Object

main

public static void main(String[] args)
                 throws RatException

Executes the generation of documentation from a configuration definition. Arguments are

1. Template directory - the top level directory in a tree of Velocity templates. The process scans the directory tree looking for files ending in .vm and processes them.
2. Output directory - The top level directory to writhe the processed files to. The process removes the .vm from the input file name and writes the resulting file to an equivalent directory entry in the output directory.

Parameters:

args - the arguments

Throws:

RatException - on RAT processing error.