com.github.jlgrock.javascriptframework.jsdocs

Class ReportGenerator

java.lang.Object

com.github.jlgrock.javascriptframework.jsdocs.ReportGenerator

public final class ReportGenerator
extends Object

A set of utility methods that help to create a jsdoc toolkit report once parameters have been gathered.

Method Summary

Methods

Modifier and Type	Method and Description
static void	executeJSDocToolkit(File jsDocApp, List<String> args, File extractDirectory) Execute the jsdoc toolkit executable.
static void	extractJSDocToolkit(File extractDirectory) Extract the jsdoc toolkit to a local dir.
static void	setConsoleOuput() Will output the console jsdoc creation logs to log4j.

Methods inherited from class java.lang.Object

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

Method Detail

extractJSDocToolkit

public static void extractJSDocToolkit(File extractDirectory)
                                throws IOException

Extract the jsdoc toolkit to a local dir.

Parameters:

extractDirectory - the directory to extract to

Throws:

IOException - if there is a problem extracting or writing files

executeJSDocToolkit

public static void executeJSDocToolkit(File jsDocApp,
                       List<String> args,
                       File extractDirectory)
                                throws org.apache.maven.reporting.MavenReportException

Execute the jsdoc toolkit executable.

Parameters:

jsDocApp - the location of the run.js within the jsDocToolkit

args - the list of arguments for the jsdoc toolkit

extractDirectory - The directory to set the execution from

Throws:

org.apache.maven.reporting.MavenReportException - for any reporting exception

setConsoleOuput

public static void setConsoleOuput()

Will output the console jsdoc creation logs to log4j.