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.

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

@see tag with leading asterisk before arguments lead to parse failure #5035

Closed
ps-sp opened this Issue Aug 31, 2017 · 1 comment

Comments

@ps-sp
Collaborator

ps-sp commented Aug 31, 2017

cat test.javadoc

* @see
* package.Class#member() 
* Description

java -jar master-8.2-all.jar -j test.javadoc

Exception in thread "main" java.lang.IllegalArgumentException: [ERROR:1] Javadoc comment at column 2 has parse error. Details: mismatched input 'package' expecting <EOF> while parsing JAVADOC
	at com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter.parseJavadocAsDetailNode(DetailNodeTreeStringPrinter.java:71)
	at com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter.parseJavadocAsDetailNode(DetailNodeTreeStringPrinter.java:83)
	at com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter.parseFile(DetailNodeTreeStringPrinter.java:173)
	at com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter.printFileAst(DetailNodeTreeStringPrinter.java:59)
	at com.puppycrawl.tools.checkstyle.Main.runCli(Main.java:406)
	at com.puppycrawl.tools.checkstyle.Main.main(Main.java:210)

cat test.javadoc

* @see
* "string"

java -jar master-8.2-all.jar -j test.javadoc

Exception in thread "main" java.lang.IllegalArgumentException: [ERROR:1] Javadoc comment at column 2 has parse error. Details: mismatched input '"string"' expecting <EOF> while parsing JAVADOC
	at com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter.parseJavadocAsDetailNode(DetailNodeTreeStringPrinter.java:71)
	at com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter.parseJavadocAsDetailNode(DetailNodeTreeStringPrinter.java:83)
	at com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter.parseFile(DetailNodeTreeStringPrinter.java:173)
	at com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter.printFileAst(DetailNodeTreeStringPrinter.java:59)
	at com.puppycrawl.tools.checkstyle.Main.runCli(Main.java:406)
	at com.puppycrawl.tools.checkstyle.Main.main(Main.java:210)

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Sep 1, 2017

Issue checkstyle#5035: Updated javadoc grammar to allow leading aster…
…isks before arguments in 'see' javadoc tag

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Sep 1, 2017

Issue checkstyle#5035: Updated javadoc grammar to allow leading aster…
…isks before arguments in 'see' javadoc tag

romani added a commit that referenced this issue Sep 1, 2017

@romani romani added this to the 8.3 milestone Sep 1, 2017

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Sep 1, 2017

Member

fix is merged.

Member

romani commented Sep 1, 2017

fix is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment