Package org.apache.rat.tools

Class Documentation

java.lang.Object

org.apache.rat.tools.Documentation

public final class Documentation
extends Object

Generates text based documentation for Licenses, LicenceFamilies, and Matchers. Utilizes the same command line as the CLI based Report client so that additional licenses, etc. can be added.

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)	Creates the documentation.

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 the documentation. Writes to the output specified by the -o or --out option. Defaults to System.out.

Parameters:

args - the arguments. Try --help for help.

Throws:

IOException - on error