Skip to content

Commit 1ecffd2

Browse files
Active JJDoc and let it create the Grammar BNF documentation (#1256)
Clean-up the Site generation
1 parent 0989810 commit 1ecffd2

File tree

1 file changed

+86
-8
lines changed

1 file changed

+86
-8
lines changed

pom.xml

Lines changed: 86 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,16 @@
168168
<goal>jjtree-javacc</goal>
169169
</goals>
170170
</execution>
171+
172+
<!-- execute JJTree explicitely in order to generate the *.jj file needed for JJDoc -->
173+
<execution>
174+
<id>jjtree</id>
175+
<phase>generate-sources</phase>
176+
<goals>
177+
<goal>jjtree</goal>
178+
</goals>
179+
</execution>
180+
171181
</executions>
172182
<dependencies>
173183
<dependency>
@@ -332,8 +342,15 @@
332342
<configuration>
333343
<useStandardDocletOptions>true</useStandardDocletOptions>
334344
<maxmemory>800m</maxmemory>
335-
<doclint>all, -missing</doclint>
336-
<excludePackageNames>net.sf.jsqlparser.parser</excludePackageNames>
345+
<doclint>none</doclint>
346+
347+
<!-- Doclint does not work on the Test Sources
348+
<doclint>all,-missing</doclint>
349+
<excludePackageNames>net.sf.jsqlparser.parser</excludePackageNames>
350+
<sourceFileExcludes>
351+
<sourceFileExclude>src/test/**</sourceFileExclude>
352+
</sourceFileExcludes>
353+
-->
337354
</configuration>
338355
</plugin>
339356
<plugin>
@@ -346,32 +363,93 @@
346363
<artifactId>maven-jxr-plugin</artifactId>
347364
<version>3.0.0</version>
348365
</plugin>
366+
367+
<!-- Cobertura is broken with Java 1.8 and there is not fix
368+
please refer to https://github.com/cobertura/cobertura/issues/248
369+
349370
<plugin>
350371
<groupId>org.codehaus.mojo</groupId>
351372
<artifactId>cobertura-maven-plugin</artifactId>
352373
<version>2.7</version>
353374
<configuration>
354375
<aggregate>true</aggregate>
355-
<outputDirectory>%{project.reporting.outputDirectory}/cobertura</outputDirectory>
376+
<outputDirectory>${project.reporting.outputDirectory}/cobertura</outputDirectory>
356377
</configuration>
357378
</plugin>
379+
-->
380+
358381
<plugin>
359382
<groupId>org.codehaus.mojo</groupId>
360383
<artifactId>findbugs-maven-plugin</artifactId>
361384
<version>3.0.5</version>
362385
</plugin>
363-
<plugin>
364-
<groupId>org.codehaus.mojo</groupId>
365-
<artifactId>javacc-maven-plugin</artifactId>
366-
<version>2.6</version>
367-
</plugin>
386+
387+
<!-- Obsolete or Unused
368388
<plugin>
369389
<groupId>org.apache.maven.plugins</groupId>
370390
<artifactId>maven-checkstyle-plugin</artifactId>
371391
<configuration>
372392
<configLocation>config/sun_checks.xml</configLocation>
373393
</configuration>
374394
</plugin>
395+
-->
396+
397+
<!-- JJDoc report generating the BNF documentation -->
398+
<plugin>
399+
<groupId>org.codehaus.mojo</groupId>
400+
<artifactId>javacc-maven-plugin</artifactId>
401+
<version>2.6</version>
402+
<configuration>
403+
<!--
404+
/**
405+
* A flag to specify the output format for the generated documentation. If set to <code>true</code>, JJDoc will
406+
* generate a plain text description of the BNF. Some formatting is done via tab characters, but the intention is to
407+
* leave it as plain as possible. Specifying <code>false</code> causes JJDoc to generate a hyperlinked HTML document
408+
* unless the parameter {@link #bnf} has been set to <code>true</code>. Default value is <code>false</code>.
409+
*
410+
* @parameter expression="${text}"
411+
*/
412+
-->
413+
<text>false</text>
414+
415+
<!--
416+
/**
417+
* A flag whether to generate a plain text document with the unformatted BNF. Note that setting this option to
418+
* <code>true</code> is only effective if the parameter {@link #text} is <code>false</code>. Default value is
419+
* <code>false</code>.
420+
*
421+
* @parameter expression="${bnf}"
422+
* @since 2.6
423+
*/
424+
-->
425+
<bnf>false</bnf>
426+
427+
<!--
428+
/**
429+
* This option controls the structure of the generated HTML output. If set to <code>true</code>, a single HTML
430+
* table for the entire BNF is generated. Setting it to <code>false</code> will produce one table for every
431+
* production in the grammar.
432+
*
433+
* @parameter expression="${oneTable}" default-value=true
434+
*/
435+
-->
436+
<oneTable>false</oneTable>
437+
438+
<!--
439+
/**
440+
* The hypertext reference to an optional CSS file for the generated HTML documents. If specified, this CSS file
441+
* will be included via a <code>&lt;link&gt;</code> element in the HTML documents. Otherwise, the default style will
442+
* be used.
443+
*
444+
* @parameter expression="${cssHref}"
445+
* @since 2.5
446+
*/
447+
-->
448+
<!-- <cssHref></cssHref> -->
449+
450+
<outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
451+
</configuration>
452+
</plugin>
375453
</plugins>
376454
</reporting>
377455

0 commit comments

Comments
 (0)