Package org.codehaus.mojo.javacc

Class JJDocMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.codehaus.mojo.javacc.JJDocMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
@Mojo(name="jjdoc", threadSafe=true) @Execute(phase=GENERATE_SOURCES) public class JJDocMojo extends org.apache.maven.reporting.AbstractMavenReport
JJDoc takes a JavaCC parser specification and produces documentation for the BNF grammar. This mojo will search the source directory for all *.jj files and run JJDoc once for each file it finds. Each of these output files, along with an index.html file will be placed in the site directory (target/site/jjdoc), and a link will be created in the "Project Reports" menu of the generated site.
Since:
2.3
Author:
Paul Gier
See Also:

  • Field Summary

    Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

    locale, mojoExecution, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

    Fields inherited from interface org.apache.maven.reporting.MavenReport

    CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    JJDocMojo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canGenerateReport()
     
    protected void
    executeReport(Locale locale)
    Run the actual report.
    String
    getDescription(Locale locale)
     
    String
    getName(Locale locale)
     
    protected String
    getOutputDirectory()
    Get the output directory of the report if run directly from the command line.
    String
    getOutputName()
    Deprecated.
    Use getOutputPath() instead.
    String
    getOutputPath()
     

    Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

    closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, isExternalReport, setReportOutputDirectory

    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 Details

    • JJDocMojo

      public JJDocMojo()

  • Method Details

    • getOutputDirectory

      protected String getOutputDirectory()
      Get the output directory of the report if run directly from the command line.
      Overrides:
      getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport
      Returns:
      The report output directory.
      See Also:
      • AbstractMavenReport.getOutputDirectory()

    • getName

      public String getName(Locale locale)
      Parameters:
      locale - The locale to use for this report.
      Returns:
      The name of this report.
      See Also:
      • MavenReport.getName(java.util.Locale)

    • getDescription

      public String getDescription(Locale locale)
      Parameters:
      locale - The locale to use for this report.
      Returns:
      The description of this report.
      See Also:
      • MavenReport.getDescription(java.util.Locale)

    • getOutputPath

      public String getOutputPath()
      Returns:
      The path of the main report file.
      See Also:
      • MavenReport.getOutputPath()

    • getOutputName

      @Deprecated public String getOutputName()
      Deprecated.
      Use getOutputPath() instead.
      Returns:
      The name of the main report file.
      See Also:
      • MavenReport.getOutputName()

    • canGenerateReport

      public boolean canGenerateReport()
      Specified by:
      canGenerateReport in interface org.apache.maven.reporting.MavenReport
      Overrides:
      canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport
      Returns:
      true if the configured source directories are not empty, false otherwise.
      See Also:
      • MavenReport.canGenerateReport()

    • executeReport

      protected void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
      Run the actual report.
      Specified by:
      executeReport in class org.apache.maven.reporting.AbstractMavenReport
      Parameters:
      locale - The locale to use for this report.
      Throws:
      org.apache.maven.reporting.MavenReportException - If the report generation failed.