-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
Parse errors if @see
spans multiple lines
#16005
Comments
@see
spans multiple lines
I want to work on this issue! @romani could you assign it to me? |
No assignments, just make comment "I am on it" and start working. |
i am on it. |
It is not easy issue, if you are new to project I recommend to do "good xxxxx issue" first. |
error goes away on removing
|
ok, but users have right to put " ." anywhere they want. |
@romani I've made some changes in grammer . how do i make them reflect in |
as you changed a grammar, just run compilation, and it will be updated. |
I want to share my analysis here to make things clear at some points. First, the issues still exist even if everything is on a single line, so "multiple lines" have nothing to do with the issue.
Second, No parse error if there is a space after the tag
Currently, The parser does not allow a description to appear immediately after an HTML element in For example, this should be valid:
Whereas for references or strings, there should be a space before the description:
We should update the parser to:
Current Rule:
Proposed update:
|
Everything that javadoc tool is passing through its execution as normal (no error) and it rendering in html, should be supported by checkstyle. Our parser should be even a bit more relaxed and resilient than javadoc tool, and we can not demand that checkstyle be executed only after javadoc tool is passing.
Ok.
Requirements should be done by Checks , not a parser. See explanation above. |
I have read check documentation: https://checkstyle.org/checks/javadoc/javadocmethod.html
I have downloaded the latest checkstyle from: https://checkstyle.org/cmdline.html#Download_and_Run
I have executed the cli and showed it below, as cli describes the problem better than 1,000 words
/var/tmp $ cat config.xml
/var/tmp $ cat YOUR_FILE.java
Describe what you expect in detail.
No parsing errors since the
javadoc
in JDK 23.0.1 tool does not report any parsing problems.The text was updated successfully, but these errors were encountered: