Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Javadoc for thrown exceptions #4

Open
wants to merge 2 commits into
base: release
Choose a base branch
from
Open

Fix Javadoc for thrown exceptions #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1fa9f1
Fix Javadoc for thrown exceptions
zbynek Feb 4, 2024
291e380
Add more Javadoc, validate output in CI
zbynek Feb 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions examples/Gwt/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,26 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.3</version>
<configuration>
<debug>true</debug>
<failOnWarnings>true</failOnWarnings>
<doclint>missing</doclint>
</configuration>

<executions>
<execution>
<id>javadoc</id>
<phase>generate-sources</phase>
<goals>
<goal>javadoc</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<name>JavaCC examples Java Simple</name>
Expand Down
12 changes: 10 additions & 2 deletions examples/Gwt/src/main/javacc/GwtSimpleParser.jj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,12 @@ import java.io.PrintStream;
/** Simple brace matcher. */
public class GwtSimpleParser {

/** Main entry point. */
/** Main entry point.
*
* @param args command line args
* @throws IOException if IO error occurs
* @throws ParseException if parsing fails
*/
public static void main(String[] args) throws ParseException, IOException {
PrintStream output = System.out;
PrintStream error = System.err;
Expand Down Expand Up @@ -89,7 +94,10 @@ public class GwtSimpleParser {

PARSER_END(GwtSimpleParser)

/** Root production. */
/** Root production.
*
* @throws ParseException if parsing fails
*/
void Input() :
{}
{
Expand Down
13 changes: 11 additions & 2 deletions examples/Gwt/src/main/javacc/GwtUnicodeParser.jj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,12 @@ import java.io.PrintStream;
/** Simple brace matcher. */
public class GwtUnicodeParser {

/** Main entry point. */
/** Main entry point.
*
* @param args command line args
* @throws IOException if IO error occurs
* @throws ParseException if parsing fails
*/
public static void main(String[] args) throws ParseException, IOException {
PrintStream output = System.out;
PrintStream error = System.err;
Expand Down Expand Up @@ -89,7 +94,11 @@ public class GwtUnicodeParser {

PARSER_END(GwtUnicodeParser)

/** Root production. */

/** Root production.
*
* @throws ParseException if parsing fails
*/
void Input() :
{}
{
Expand Down
20 changes: 20 additions & 0 deletions examples/JavaCC/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,26 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.3</version>
<configuration>
<debug>true</debug>
<failOnWarnings>true</failOnWarnings>
<doclint>missing</doclint>
</configuration>

<executions>
<execution>
<id>javadoc</id>
<phase>generate-sources</phase>
<goals>
<goal>javadoc</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
93 changes: 72 additions & 21 deletions src/main/java/org/javacc/java/ParserCodeGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,10 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
}
codeGenerator.println(" }");
codeGenerator.println("");
codeGenerator.println(" /** Reinitialise. */");
codeGenerator.println(" /** Reinitialise.");
codeGenerator.println(" *");
codeGenerator.println(" * @param stream input stream");
codeGenerator.println(" */");
codeGenerator.println(" public " + JavaUtil.getStatic() + "void ReInit(CharStream stream) {");

if (Options.isTokenManagerRequiresParserAccess()) {
Expand Down Expand Up @@ -345,12 +348,19 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
} else {

if (!isJavaModernMode) {
codeGenerator.println(" /** Constructor with InputStream. */");
codeGenerator.println(" /** Constructor with InputStream.");
codeGenerator.println(" *");
codeGenerator.println(" * @param stream input stream");
codeGenerator.println(" */");
codeGenerator.println(" public " + context.globals().cu_name + "(java.io.InputStream stream) {");
codeGenerator.println(" this(stream, null);");
codeGenerator.println(" this(stream, null);");
codeGenerator.println(" }");
codeGenerator.println();
codeGenerator.println(" /** Constructor with InputStream and supplied encoding. */");
codeGenerator.println(" /** Constructor with InputStream and supplied encoding.");
codeGenerator.println(" *");
codeGenerator.println(" * @param stream input stream");
codeGenerator.println(" * @param encoding character encoding");
codeGenerator.println(" */");
codeGenerator
.println(" public " + context.globals().cu_name + "(java.io.InputStream stream, String encoding) {");
if (Options.getStatic()) {
Expand Down Expand Up @@ -418,14 +428,22 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
codeGenerator.println(" }");
codeGenerator.println("");

codeGenerator.println(" /** Reinitialise. */");
codeGenerator.println(" /** Reinitialise.");
codeGenerator.println(" *");
codeGenerator.println(" * @param stream input stream");
codeGenerator.println(" */");
codeGenerator
.println(" public " + JavaUtil.getStatic() + "void ReInit(java.io.InputStream stream) {");
codeGenerator.println(" ReInit(stream, null);");
codeGenerator.println(" }");

codeGenerator.println();
codeGenerator.println(" /** Reinitialise. */");

codeGenerator.println(" /** Reinitialise.");
codeGenerator.println(" *");
codeGenerator.println(" * @param stream input stream");
codeGenerator.println(" * @param encoding encoding");
codeGenerator.println(" */");
codeGenerator.println(
" public " + JavaUtil.getStatic() + "void ReInit(java.io.InputStream stream, String encoding) {");

Expand Down Expand Up @@ -477,7 +495,10 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
final String stringReaderClass = isJavaModernMode ? "StringProvider" : "java.io.StringReader";


codeGenerator.println(" /** Constructor. */");
codeGenerator.println(" /** Constructor.");
codeGenerator.println(" *");
codeGenerator.println(" * @param stream provider of the input stream");
codeGenerator.println(" */");
codeGenerator.println(" public " + context.globals().cu_name + "(" + readerInterfaceName + " stream) {");
if (Options.getStatic()) {
codeGenerator.println(" if (jj_initialized_once) {");
Expand Down Expand Up @@ -530,7 +551,13 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
// only to prevent regressions)
if (isJavaModernMode) {
codeGenerator.println("");
codeGenerator.println(" /** Constructor. */");
codeGenerator.println(" /** Constructor. ");
codeGenerator.println(" *");
codeGenerator.println(" * @param dsl string to be parsed");
codeGenerator.println(" * @throws ParseException if parsing fails");
codeGenerator.println(" * @throws " + JavaTemplates.getTokenMgrErrorClass()
+ " if tokenization fails");
codeGenerator.println(" */ ");
codeGenerator.println(" public " + context.globals().cu_name + "(String dsl) throws ParseException, "
+ JavaTemplates.getTokenMgrErrorClass() + " {");
codeGenerator.println(" this(new " + stringReaderClass + "(dsl));");
Expand All @@ -544,7 +571,10 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
}

codeGenerator.println();
codeGenerator.println(" /** Reinitialise. */");
codeGenerator.println(" /** Reinitialise.");
codeGenerator.println(" *");
codeGenerator.println(" * @param stream input stream");
codeGenerator.println(" */ ");
codeGenerator
.println(" public " + JavaUtil.getStatic() + "void ReInit(" + readerInterfaceName + " stream) {");
if (Options.getJavaUnicodeEscape()) {
Expand Down Expand Up @@ -609,13 +639,19 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
}
}
codeGenerator.println("");
if (Options.getUserTokenManager()) {
codeGenerator.println(" /** Constructor with user supplied Token Manager. */");
codeGenerator.println(" public " + context.globals().cu_name + "(TokenManager tm) {");
} else {
codeGenerator.println(" /** Constructor with generated Token Manager. */");
codeGenerator.println(" public " + context.globals().cu_name + "(" + context.globals().cu_name + "TokenManager tm) {");
String managerType = "user supplied";
String managerClassName = "TokenManager";
if (!Options.getUserTokenManager()) {
managerType = "generated";
managerClassName = context.globals().cu_name + managerClassName;
}
codeGenerator.println(" /** Constructor with " + managerType + " Token Manager.");
codeGenerator.println(" *");
codeGenerator.println(" * @param tm token manager");
codeGenerator.println(" */");
codeGenerator.println(" public " + context.globals().cu_name
+ "(" + managerClassName + " tm) {");

if (Options.getStatic()) {
codeGenerator.println(" if (jj_initialized_once) {");
codeGenerator.println(" System.out.println(\"ERROR: Second call to constructor of static parser. \");");
Expand Down Expand Up @@ -652,11 +688,13 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
}
codeGenerator.println(" }");
codeGenerator.println("");
codeGenerator.println(" /** Reinitialise.");
codeGenerator.println(" *");
codeGenerator.println(" * @param tm token manager");
codeGenerator.println(" */");
if (Options.getUserTokenManager()) {
codeGenerator.println(" /** Reinitialise. */");
codeGenerator.println(" public void ReInit(TokenManager tm) {");
} else {
codeGenerator.println(" /** Reinitialise. */");
codeGenerator.println(" public void ReInit(" + context.globals().cu_name + "TokenManager tm) {");
}
codeGenerator.println(" token_source = tm;");
Expand Down Expand Up @@ -792,7 +830,10 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
codeGenerator.println("");
}
codeGenerator.println("");
codeGenerator.println("/** Get the next Token. */");
codeGenerator.println(" /** Get the next Token.");
codeGenerator.println(" *");
codeGenerator.println(" * @return the next token");
codeGenerator.println(" */");
codeGenerator.println(" public " + JavaUtil.getStatic() + "final Token getNextToken() {");
if (Options.getCacheTokens()) {
codeGenerator.println(" if ((token = jj_nt).next != null) {");
Expand All @@ -817,7 +858,11 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
codeGenerator.println(" return token;");
codeGenerator.println(" }");
codeGenerator.println("");
codeGenerator.println("/** Get the specific Token. */");
codeGenerator.println(" /** Get the specific Token.");
codeGenerator.println(" *");
codeGenerator.println(" * @param index token index");
codeGenerator.println(" * @return token at given index");
codeGenerator.println(" */");
codeGenerator.println(" public " + JavaUtil.getStatic() + "final Token getToken(int index) {");
if (context.globals().lookaheadNeeded) {
codeGenerator.println(" Token t = jj_lookingAhead ? jj_scanpos : token;");
Expand Down Expand Up @@ -904,7 +949,10 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
codeGenerator.println(" }");
}
codeGenerator.println("");
codeGenerator.println(" /** Generate ParseException. */");
codeGenerator.println(" /** Generate ParseException.");
codeGenerator.println(" *");
codeGenerator.println(" * @return the parse exception");
codeGenerator.println(" */");
codeGenerator.println(" public " + JavaUtil.getStatic() + "ParseException generateParseException() {");
codeGenerator.println(" jj_expentries.clear();");
codeGenerator.println(" " + JavaUtil.getBooleanType() + "[] la1tokens = new " + JavaUtil.getBooleanType() + "["
Expand Down Expand Up @@ -982,7 +1030,10 @@ public void generateCode(CodeGeneratorSettings settings, ParserData parserData)
codeGenerator
.println(" private " + JavaUtil.getStatic() + JavaUtil.getBooleanType() + " trace_enabled;");
codeGenerator.println("");
codeGenerator.println("/** Trace enabled. */");
codeGenerator.println(" /** Trace enabled.");
codeGenerator.println(" *");
codeGenerator.println(" * @return whether trace is enabled");
codeGenerator.println(" */");
codeGenerator.println(" public " + JavaUtil.getStatic() + "final boolean trace_enabled() {");
codeGenerator.println(" return trace_enabled;");
codeGenerator.println(" }");
Expand Down
Loading
Loading