Package org.noise_planet.noisemodelling.autodoc

Class GenerateFunctionsDocs

java.lang.Object

org.noise_planet.noisemodelling.autodoc.GenerateFunctionsDocs

public class GenerateFunctionsDocs
extends Object

Parses Groovy WPS scripts and generates RST documentation files for each script, as well as the main Functions.rst index.

Bound to the Maven package phase via the exec-maven-plugin in noisemodelling-scripts/pom.xml.

Constructor Summary

Constructors

Constructor	Description
GenerateFunctionsDocs()

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Constructor Details

GenerateFunctionsDocs

public GenerateFunctionsDocs()

Method Details

main

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

Parameters:

args - args[0] = path to Docs directory (default: "../Docs"), args[1] = path to groovy scripts root directory (default: "src/main/groovy/org/noise_planet/noisemodelling/scripts")

Throws:

IOException

NoSuchAlgorithmException