Skip to content

Invalid JavaDoc generated #206

@ian-semmle

Description

@ian-semmle

JFlex generates invalid JavaDoc.

For example, using the example test.flex from http://jflex.de/manual.html#Example:

$ jflex test.flex
Reading "test.flex"
Constructing NFA : 171 states in NFA
Converting NFA to DFA : 
............................................................
64 states before minimization, 45 states in minimized DFA
Writing code to "Lexer.java"

we get:

$ javadoc -Xdoclint:syntax -private Lexer.java
[...]
Lexer.java:369: error: malformed HTML
   * zzAtBOL == true <=> the scanner is currently at the beginning of a line
                     ^
Lexer.java:369: error: bad use of '>'
   * zzAtBOL == true <=> the scanner is currently at the beginning of a line
                       ^
Lexer.java:373: error: malformed HTML
  /** zzAtEOF == true <=> the scanner is at the EOF */
                      ^
Lexer.java:373: error: bad use of '>'
  /** zzAtEOF == true <=> the scanner is at the EOF */
                        ^
[...]

I'd recommend changing all instances of <=> to iff in the templates.

Metadata

Metadata

Assignees

Labels

taskProcess tasks

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions