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.

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

Issue #14631: Updated DEPRECATED_LITERAL of JavadocTokenTypes to new AST format #14632

Merged
merged 1 commit into from
Mar 9, 2024

Conversation

MANISH-K-07
Copy link
Contributor

Begins #14631

E:\MANISH\Workspace>cat Test.java
public class Test {
 /**
   * Some Java doc.
   *
   * @param p1 The first number
   * @deprecated It is deprecated method
   */
  @Deprecated
  private int boo(int p1) {
      return p1;
  }
}
E:\MANISH\Workspace>java -jar checkstyle-10.13.0-all.jar -J Test.java | sed "s/->/-\>/g; s/\[[0-9]\+:[0-9]\+\]//g"
COMPILATION_UNIT -> COMPILATION_UNIT
`--CLASS_DEF -> CLASS_DEF
    |--MODIFIERS -> MODIFIERS
    |   `--LITERAL_PUBLIC -> public
    |--LITERAL_CLASS -> class
    |--IDENT -> Test
    `--OBJBLOCK -> OBJBLOCK
        |--LCURLY -> {
        |--METHOD_DEF -> METHOD_DEF
        |   |--MODIFIERS -> MODIFIERS
        |   |   |--ANNOTATION -> ANNOTATION
        |   |   |   |--BLOCK_COMMENT_BEGIN -> /*
        |   |   |   |   |--COMMENT_CONTENT -> *\n   * Some Java doc.\n   *\n   * @param p1 The first number\n   * @deprecated It is deprecated method\n
        |   |   |   |   |   `--JAVADOC -> JAVADOC
        |   |   |   |   |       |--NEWLINE -> \n
        |   |   |   |   |       |--LEADING_ASTERISK ->    *
        |   |   |   |   |       |--TEXT ->  Some Java doc.
        |   |   |   |   |       |--NEWLINE -> \n
        |   |   |   |   |       |--LEADING_ASTERISK ->    *
        |   |   |   |   |       |--NEWLINE -> \n
        |   |   |   |   |       |--LEADING_ASTERISK ->    *
        |   |   |   |   |       |--WS ->
        |   |   |   |   |       |--JAVADOC_TAG -> JAVADOC_TAG
        |   |   |   |   |       |   |--PARAM_LITERAL -> @param
        |   |   |   |   |       |   |--WS ->
        |   |   |   |   |       |   |--PARAMETER_NAME -> p1
        |   |   |   |   |       |   |--WS ->
        |   |   |   |   |       |   `--DESCRIPTION -> DESCRIPTION
        |   |   |   |   |       |       |--TEXT -> The first number
        |   |   |   |   |       |       `--NEWLINE -> \n
        |   |   |   |   |       |--LEADING_ASTERISK ->    *
        |   |   |   |   |       |--WS ->
        |   |   |   |   |       |--JAVADOC_TAG -> JAVADOC_TAG
        |   |   |   |   |       |   |--DEPRECATED_LITERAL -> @deprecated
        |   |   |   |   |       |   |--WS ->
        |   |   |   |   |       |   `--DESCRIPTION -> DESCRIPTION
        |   |   |   |   |       |       |--TEXT -> It is deprecated method
        |   |   |   |   |       |       |--NEWLINE -> \n
        |   |   |   |   |       |       `--TEXT ->
        |   |   |   |   |       `--EOF -&gt; <EOF>
        |   |   |   |   `--BLOCK_COMMENT_END -&gt; */
        |   |   |   |--AT -&gt; @
        |   |   |   `--IDENT -&gt; Deprecated
        |   |   `--LITERAL_PRIVATE -&gt; private
        |   |--TYPE -&gt; TYPE
        |   |   `--LITERAL_INT -&gt; int
        |   |--IDENT -&gt; boo
        |   |--LPAREN -&gt; (
        |   |--PARAMETERS -&gt; PARAMETERS
        |   |   `--PARAMETER_DEF -&gt; PARAMETER_DEF
        |   |       |--MODIFIERS -&gt; MODIFIERS
        |   |       |--TYPE -&gt; TYPE
        |   |       |   `--LITERAL_INT -&gt; int
        |   |       `--IDENT -&gt; p1
        |   |--RPAREN -&gt; )
        |   `--SLIST -&gt; {
        |       |--LITERAL_RETURN -&gt; return
        |       |   |--EXPR -&gt; EXPR
        |       |   |   `--IDENT -&gt; p1
        |       |   `--SEMI -&gt; ;
        |       `--RCURLY -&gt; }
        `--RCURLY -&gt; }

E:\MANISH\Workspace>

Copy link
Member

@romani romani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot.

I highly recommend you to dealing with complicated issues, good first issues are created for people who starting to learn Engineering

@romani romani merged commit 899f3ed into checkstyle:master Mar 9, 2024
113 checks passed
@MANISH-K-07 MANISH-K-07 deleted the javadocTokenD branch March 9, 2024 13:24
@MANISH-K-07
Copy link
Contributor Author

Thanks a lot.

I highly recommend you to dealing with complicated issues, good first issues are created for people who starting to learn Engineering

Sure @romani , Honoured that you feel that way ❤️
Working on a few as we speak !! Related PRs are open too

This Issue had no example updates for future contributors to refer to.. So, I thought maybe one commit would be helpful for them

@romani
Copy link
Member

romani commented Mar 10, 2024

I appreciate your help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants