com.github.jlgrock.javascriptframework.jsdocs
Class JsDocsJsarMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsMojo
          com.github.jlgrock.javascriptframework.jsdocs.JsDocsMojo
              com.github.jlgrock.javascriptframework.jsdocs.JsDocsJsarMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AggregateJsDocsJsarMojo

public class JsDocsJsarMojo
extends JsDocsMojo

Generates javascript docs from the jsdoc-toolkit (the final version) and stores them into a js archive.

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

JsDocsJsarMojo()

Method Summary

protected File

getArchiveOutputDirectory() return the file location of where the archive of the jsdocs should be placed.

Methods inherited from class com.github.jlgrock.javascriptframework.jsdocs.JsDocsMojo

generate, getClassifier, getReportOutputDirectory, getSourceDirectories, isAggregator, main

Methods inherited from class com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsMojo

archive, createArgumentStack, createJsDocs, execute, executeJSDocs, getBaseDir, getDestDir, getFinalName, getOutputDirectory, getTemplate, getToolkitExtractDirectory, isCaseSensitive, isIncludePrivate, isUseNamespacedFiles, setConsoleOuput, setOutputDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

JsDocsJsarMojo

public JsDocsJsarMojo()

Method Detail

getArchiveOutputDirectory

protected File getArchiveOutputDirectory()

Description copied from class: AbstractJsDocsMojo

return the file location of where the archive of the jsdocs should be placed. This should return null if no archive is expected to be created.

Overrides:

getArchiveOutputDirectory in class JsDocsMojo

Returns:

the output directory or null