Skip to content

Conversation

@KishorMore-2005
Copy link
Contributor

@KishorMore-2005 KishorMore-2005 commented Oct 13, 2025

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
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

@KishorMore-2005
Copy link
Contributor Author

KishorMore-2005 commented Oct 14, 2025

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

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:

*
* <b>Tree:</b>
* <pre>{@code
* |--JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG
Copy link
Member

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.

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

*
* @see #JAVADOC_BLOCK_TAG
*/
public static final int INDEX_INLINE_TAG = JavadocCommentsLexer.INDEX_INLINE_TAG;
Copy link
Member

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

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

* </ol>
*
* <p><b>Example:</b></p>
* <pre>{@code * @index This parameter specifies the position.}</pre>
Copy link
Member

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants