Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Issue #17882: Update {@index} of JavadocCommentsTokenTypes to new AST format #17926

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Issue #17882: Update {@index} of JavadocCommentsTokenTypes to new AST format #17926

wants to merge 1 commit into from

Conversation

@KishorMore-2005
Copy link
Contributor

@KishorMore-2005 KishorMore-2005 commented Oct 13, 2025 •
edited
Loading

Issue #17882

JAVADOC -> JAVADOC
`--JAVADOC_CONTENT -> JAVADOC_CONTENT
    |--NEWLINE -> \n
    |--LEADING_ASTERISK ->      *
    |--TEXT ->  {@code {@index}} inline tag.
    |--NEWLINE -> \n
    |--LEADING_ASTERISK ->      *
    |--NEWLINE -> \n
    |--LEADING_ASTERISK ->      *
    |--TEXT ->  
    |--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
    |   `--PARAM_BLOCK_TAG -> PARAM_BLOCK_TAG
    |       |--AT_SIGN -> @
    |       |--TAG_NAME -> param
    |       |--TEXT ->  
    |       |--PARAMETER_NAME -> value
    |       `--DESCRIPTION -> DESCRIPTION
    |           `--TEXT ->  The parameter of the method.

@KishorMore-2005 KishorMore-2005 force-pushed the fifth branch 3 times, most recently from ec01256 to 3d74c79 Compare October 13, 2025 19:56
romani
romani requested changes Oct 14, 2025
View reviewed changes
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.

Item

@Atharv3221 Atharv3221 mentioned this pull request Oct 14, 2025
Open
@KishorMore-2005
Copy link
Contributor Author

KishorMore-2005 commented Oct 14, 2025 •
edited
Loading

@romani How to solve these error "https://circleci.com/gh/checkstyle/checkstyle/1100967"

romani
romani requested changes Oct 15, 2025
View reviewed changes
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 .

last:

src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocCommentsTokenTypes.java Outdated
*
* <b>Tree:</b>
* <pre>{@code
* |--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
Copy link
Member

@romani romani Oct 15, 2025

Choose a reason for hiding this comment

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

plase remove |-- and related | under it.
shift tree to the left.

romani
romani requested changes Oct 15, 2025
View reviewed changes
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.

Item

src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocCommentsTokenTypes.java
*
* @see #JAVADOC_BLOCK_TAG
*/
public static final int INDEX_INLINE_TAG = JavadocCommentsLexer.INDEX_INLINE_TAG;
Copy link
Member

@romani romani Oct 15, 2025

Choose a reason for hiding this comment

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

I don't see INDEX_INLINE_TAG in tree

romani
romani requested changes Oct 16, 2025
View reviewed changes
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.

Item

src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocCommentsTokenTypes.java
* </ol>
*
* <p><b>Example:</b></p>
* <pre>{@code * @index This parameter specifies the position.}</pre>
Copy link
Member

@romani romani Oct 16, 2025

Choose a reason for hiding this comment

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

Instead of "index" that might look like javadoc specific, use "someName" to make it clear that it is not existing tag

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

Reviewers

@romani romani romani requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@KishorMore-2005 @romani