Package org.apache.rat.tools

Class AntDocumentation

java.lang.Object

org.apache.rat.tools.AntDocumentation

public final class AntDocumentation
extends Object

A simple tool to convert CLI options into an Ant report base class.

Method Summary

Modifier and Type	Method	Description
void	execute()
static void	main(String[] args)	Creates apt documentation files for Ant.
void	writeAttributes(List<AntOption> options)
void	writeElements(List<AntOption> options)

Methods inherited from class java.lang.Object

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

Method Details

main

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

Creates apt documentation files for Ant. Requires 1 argument:

1. the directory in which to write the documentation files.

Parameters:

args - the arguments.

Throws:

IOException - on error

execute

public void execute()

writeAttributes

public void writeAttributes(List<AntOption> options)

writeElements

public void writeElements(List<AntOption> options)