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

Add (WS | NEWLINE) in proper places for javadoc tags #4934

Closed
ps-sp opened this Issue Aug 11, 2017 · 3 comments

Comments

@ps-sp
Collaborator

ps-sp commented Aug 11, 2017

$ cat test.javadoc

* @exception Exception-javadoc-description

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

JAVADOC -> JAVADOC [0:0]
|--LEADING_ASTERISK -> * [0:0]
|--WS ->   [0:1]
|--JAVADOC_TAG -> JAVADOC_TAG [0:2]
|   |--EXCEPTION_LITERAL -> @exception [0:2]
|   |--WS ->   [0:12]
|   |--CLASS_NAME -> Exception [0:13]
|   `--DESCRIPTION -> DESCRIPTION [0:22]
|       |--TEXT -> **-javadoc-description** [0:22]
|       `--NEWLINE -> \n [0:42]
`--EOF -> <EOF> [1:0]

As can be seen the tree doesn't seem correct and WS should be enforced before description as even the syntax for @exception in oracle docs suggests.

Another example:

$ cat test.javadoc

* @param Exception-javadoc-description

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

JAVADOC -> JAVADOC [0:0]
|--LEADING_ASTERISK -> * [0:0]
|--WS ->   [0:1]
|--JAVADOC_TAG -> JAVADOC_TAG [0:2]
|   |--PARAM_LITERAL -> @param [0:2]
|   |--WS ->   [0:8]
|   |--PARAMETER_NAME -> Exception [0:9]
|   `--DESCRIPTION -> DESCRIPTION [0:18]
|       |--TEXT -> **-javadoc-description** [0:18]
|       `--NEWLINE -> \n [0:38]
`--EOF -> <EOF> [1:0]

So WS should be added in all the right places for javadoc tags based on their syntax in oracle docs.

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 11, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 11, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 11, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 11, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 12, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 12, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 12, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 21, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 21, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 21, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 21, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 21, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 22, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 22, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 22, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 22, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 22, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 24, 2017

romani added a commit that referenced this issue Aug 24, 2017

@romani romani added this to the 8.2 milestone Aug 24, 2017

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Aug 24, 2017

Member

fix is merged

Member

romani commented Aug 24, 2017

fix is merged

@romani romani closed this Aug 24, 2017

@ps-sp

This comment has been minimized.

Show comment
Hide comment
@ps-sp

ps-sp Aug 24, 2017

Collaborator

@romani Issue is not fixed yet. That PR just concerned with all block javadoc tags except @see. Please reopen.

UPDATE: No need to reopen. It can be done along with #4942 . I don't think it will result in any added diff counts.

Collaborator

ps-sp commented Aug 24, 2017

@romani Issue is not fixed yet. That PR just concerned with all block javadoc tags except @see. Please reopen.

UPDATE: No need to reopen. It can be done along with #4942 . I don't think it will result in any added diff counts.

@romani romani reopened this Aug 24, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 25, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 25, 2017

Issue #4934: Javadoc grammar is not to support string without quotes …
…in '@see' tag. Updated 'wercker.yml' to apply a patch to pgjdbc repo which fixes one such javadoc

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 27, 2017

Issue #4934: Javadoc grammar is not to support string without quotes …
…in '@see' tag. Updated 'wercker.yml' to apply a patch to pgjdbc repo which fixes one such javadoc

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 27, 2017

Issue #4934: Javadoc grammar is not to support string without quotes …
…in '@see' tag. Updated 'wercker.yml' to apply a patch to pgjdbc repo. Revertible after pgjdbc/pgjdbc#926

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 27, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 27, 2017

Issue #4934: Javadoc grammar is not to support string without quotes …
…in '@see' tag. Updated 'wercker.yml' to apply a patch to pgjdbc repo. Revertible after pgjdbc/pgjdbc#926

romani added a commit that referenced this issue Aug 28, 2017

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Aug 28, 2017

Member

fix is merged

Member

romani commented Aug 28, 2017

fix is merged

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