Skip to content

Commit

Permalink
Active JJDoc and let it create the Grammar BNF documentation
Browse files Browse the repository at this point in the history
Clean-up the Site generation
  • Loading branch information
manticore-projects committed Jul 6, 2021
1 parent 111244a commit 1b5d133
Showing 1 changed file with 86 additions and 8 deletions.
94 changes: 86 additions & 8 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,16 @@
<goal>jjtree-javacc</goal>
</goals>
</execution>

<!-- execute JJTree explicitely in order to generate the *.jj file needed for JJDoc -->
<execution>
<id>jjtree</id>
<phase>generate-sources</phase>
<goals>
<goal>jjtree</goal>
</goals>
</execution>

</executions>
<dependencies>
<dependency>
Expand Down Expand Up @@ -332,8 +342,15 @@
<configuration>
<useStandardDocletOptions>true</useStandardDocletOptions>
<maxmemory>800m</maxmemory>
<doclint>all, -missing</doclint>
<excludePackageNames>net.sf.jsqlparser.parser</excludePackageNames>
<doclint>none</doclint>

<!-- Doclint does not work on the Test Sources
<doclint>all,-missing</doclint>
<excludePackageNames>net.sf.jsqlparser.parser</excludePackageNames>
<sourceFileExcludes>
<sourceFileExclude>src/test/**</sourceFileExclude>
</sourceFileExcludes>
-->
</configuration>
</plugin>
<plugin>
Expand All @@ -346,32 +363,93 @@
<artifactId>maven-jxr-plugin</artifactId>
<version>3.0.0</version>
</plugin>

<!-- Cobertura is broken with Java 1.8 and there is not fix
please refer to https://github.com/cobertura/cobertura/issues/248
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>cobertura-maven-plugin</artifactId>
<version>2.7</version>
<configuration>
<aggregate>true</aggregate>
<outputDirectory>%{project.reporting.outputDirectory}/cobertura</outputDirectory>
<outputDirectory>${project.reporting.outputDirectory}/cobertura</outputDirectory>
</configuration>
</plugin>
-->

<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<version>3.0.5</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>javacc-maven-plugin</artifactId>
<version>2.6</version>
</plugin>

<!-- Obsolete or Unused
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
<configLocation>config/sun_checks.xml</configLocation>
</configuration>
</plugin>
-->

<!-- JJDoc report generating the BNF documentation -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>javacc-maven-plugin</artifactId>
<version>2.6</version>
<configuration>
<!--
/**
* A flag to specify the output format for the generated documentation. If set to <code>true</code>, JJDoc will
* generate a plain text description of the BNF. Some formatting is done via tab characters, but the intention is to
* leave it as plain as possible. Specifying <code>false</code> causes JJDoc to generate a hyperlinked HTML document
* unless the parameter {@link #bnf} has been set to <code>true</code>. Default value is <code>false</code>.
*
* @parameter expression="${text}"
*/
-->
<text>false</text>

<!--
/**
* A flag whether to generate a plain text document with the unformatted BNF. Note that setting this option to
* <code>true</code> is only effective if the parameter {@link #text} is <code>false</code>. Default value is
* <code>false</code>.
*
* @parameter expression="${bnf}"
* @since 2.6
*/
-->
<bnf>false</bnf>

<!--
/**
* This option controls the structure of the generated HTML output. If set to <code>true</code>, a single HTML
* table for the entire BNF is generated. Setting it to <code>false</code> will produce one table for every
* production in the grammar.
*
* @parameter expression="${oneTable}" default-value=true
*/
-->
<oneTable>false</oneTable>

<!--
/**
* The hypertext reference to an optional CSS file for the generated HTML documents. If specified, this CSS file
* will be included via a <code>&lt;link&gt;</code> element in the HTML documents. Otherwise, the default style will
* be used.
*
* @parameter expression="${cssHref}"
* @since 2.5
*/
-->
<!-- <cssHref></cssHref> -->

<outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
</configuration>
</plugin>
</plugins>
</reporting>

Expand Down

0 comments on commit 1b5d133

Please sign in to comment.