Skip to content

Issue #18435:Remove javadoctagcontinuationindentation Example4 from(X…#18572

Merged
romani merged 1 commit into
checkstyle:masterfrom
ZaheerAhmadDev:Fix-XdocsExamplesAstConsistencyTest
Jan 24, 2026
Merged

Issue #18435:Remove javadoctagcontinuationindentation Example4 from(X…#18572
romani merged 1 commit into
checkstyle:masterfrom
ZaheerAhmadDev:Fix-XdocsExamplesAstConsistencyTest

Conversation

@ZaheerAhmadDev

@ZaheerAhmadDev ZaheerAhmadDev commented Jan 9, 2026

Copy link
Copy Markdown
Contributor

Issue : #18435

Remove javadoctagcontinuationindentation Example4 from XdocsExamplesAstconsistencyTest.
Updated Example1–Example4 so they now have the same AST structure.

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch 4 times, most recently from 1f45891 to 91eff98 Compare January 10, 2026 06:15
@romani

romani commented Jan 10, 2026

Copy link
Copy Markdown
Member

Example of Pull Request with diff image to prove that content of examples is same #18505

please share diff.

not clear why you removed method that is target forjavadoc

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch from 91eff98 to d41f4a5 Compare January 10, 2026 07:12
@ZaheerAhmadDev

Copy link
Copy Markdown
Contributor Author

https://www.diffchecker.com/tmg7tNi2/
Example 1 vs Example 4.pdf
The reason for removal of testmethod 3 to match Example4 Ast to Example1.
The code of Example1 and Example4 were same.

@romani

romani commented Jan 10, 2026

Copy link
Copy Markdown
Member

please put

   * @tag comment
   *     Indentation spacing is 4

and similar tags from exmaple1-3 to exmple4

make Exmaple1-3 as example4.

Diff should be minimal as I shared in example

@ZaheerAhmadDev

ZaheerAhmadDev commented Jan 10, 2026

Copy link
Copy Markdown
Contributor Author

@romani,
make Exmaple1-3 as example4 ?
should i make Example1,2,3 as Example4 by adding testmethod3() ?
And Add these tags inside Example4 from Example1,2,3?

Screenshot 2026-01-10 181757

@romani

romani commented Jan 11, 2026

Copy link
Copy Markdown
Member

You can do everything to make them the same.

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch 2 times, most recently from c9437f5 to 07d5ad1 Compare January 11, 2026 03:55
@ZaheerAhmadDev

ZaheerAhmadDev commented Jan 11, 2026

Copy link
Copy Markdown
Contributor Author

https://www.diffchecker.com/Ip67wmBp/
I Updated Example 1,2,3 to look like Example 4 by adding testmethod3.
The example4 javadoc is different is because as it explaining pre and code tag.

@romani

romani commented Jan 11, 2026

Copy link
Copy Markdown
Member

{} should be for all methods.
Please make all examples the same, just merge all example snippets to single java file.

Only and only comments o violations should be different

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch from 07d5ad1 to 5517f85 Compare January 11, 2026 08:01
@ZaheerAhmadDev

Copy link
Copy Markdown
Contributor Author
Snipet of all example Here is the snippet of all Example1-3 added testmethod. Only comments are different as they explain violation. And the javadoc of Example4 As it explain indentation with pre and code tag.

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch from 5517f85 to c15d5bc Compare January 11, 2026 12:53
@romani

romani commented Jan 12, 2026

Copy link
Copy Markdown
Member

GitHub, generate website

@romani

romani commented Jan 12, 2026

Copy link
Copy Markdown
Member

Please share diffchecker links to speed up review

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch from c15d5bc to 729f448 Compare January 12, 2026 02:52
@ZaheerAhmadDev

Copy link
Copy Markdown
Contributor Author

https://www.diffchecker.com/X8i8BYcO/
https://www.diffchecker.com/uRQutKrO/
https://www.diffchecker.com/6NJbIi9e/
Here is diffchecker of Example1 vs Example2 and Example1 vs Example3 and Example1 vs 4.
The javadoc of example4 is different because it show pre and code tag.
The code of all example is same only comments are different.

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch 4 times, most recently from 1f2d331 to fd8315d Compare January 16, 2026 07:19
@ZaheerAhmadDev

Copy link
Copy Markdown
Contributor Author

@romani ,
Here is overall diff. Please let me know if any changes are required

https://www.diffchecker.com/X8i8BYcO/ https://www.diffchecker.com/uRQutKrO/ https://www.diffchecker.com/6NJbIi9e/ Here is diffchecker of Example1 vs Example2 and Example1 vs Example3 and Example1 vs 4. The javadoc of example4 is different because it show pre and code tag. The code of all example is same only comments are different.

@romani

romani commented Jan 16, 2026

Copy link
Copy Markdown
Member

GitHub, generate website

@romani

romani commented Jan 16, 2026

Copy link
Copy Markdown
Member
image

Examples must be same, please copy methods with big javadoc from Example 4 all other Examples.
Differences should be only in violation comments.


example 1 vs 3
image

please avoid 1 and 2 , just keep Attention to Indentation spacing

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch from fd8315d to 7d6862f Compare January 16, 2026 15:47
@ZaheerAhmadDev

ZaheerAhmadDev commented Jan 22, 2026

Copy link
Copy Markdown
Contributor Author

@romani,
https://www.diffchecker.com/86Ky19Zm/
https://www.diffchecker.com/6bLkawxW/
https://www.diffchecker.com/ltke2iM6/

I compare all the examples by using diffchecker all the Examples are same.
All the code and javadoc is same in all the examples in diffcheck.
only violation comments are different as they explain violation.
please let me know if any other changes are required in examples.

@ZaheerAhmadDev

ZaheerAhmadDev commented Jan 22, 2026

Copy link
Copy Markdown
Contributor Author

GitHub, generate website

@romani

romani commented Jan 22, 2026

Copy link
Copy Markdown
Member
Screenshot_20260122-110828

@romani

romani commented Jan 22, 2026

Copy link
Copy Markdown
Member

No diff. Please.

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch 3 times, most recently from f634481 to 63ab1eb Compare January 23, 2026 10:34
@ZaheerAhmadDev

Copy link
Copy Markdown
Contributor Author
Screenshot 2026-01-23 153234

Now, all Examples 1–4 use the same set of methods and Javadoc.
Only violation comments different.
I removed the extra method like testIndentation1, testIndentation2 etc to follow the Xdocs AST consistency requirement.
I checked all the Examples by using diffchecker the code and javadoc are all same now.

@romani

romani commented Jan 23, 2026

Copy link
Copy Markdown
Member

GitHub, generate website

@romani

romani commented Jan 23, 2026

Copy link
Copy Markdown
Member

please share diffchecker links after website is generated.
Lets merge this PR sooner.

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch from 63ab1eb to 91534c3 Compare January 23, 2026 14:43
@ZaheerAhmadDev

Copy link
Copy Markdown
Contributor Author

@romani,
https://www.diffchecker.com/3bWzmxpH/
https://www.diffchecker.com/xw49BlZL/
https://www.diffchecker.com/KWgsr6Ab/
Here is diffchecker links of all the Examples.All the Examples are same now.

@romani

romani commented Jan 23, 2026

Copy link
Copy Markdown
Member

Javadoc is code here it should be same.
If you need two different indentations, please create two methods+javadoc.

Screenshot_20260123-082309

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch 2 times, most recently from 822569e to b8f9ffd Compare January 24, 2026 05:16
@ZaheerAhmadDev

Copy link
Copy Markdown
Contributor Author

Now all the Javadoc code is same. created two methods in All the Example one for default and one for violation.
the only difference is Violation comments and config in all example.
Screenshot 2026-01-24 101142
Screenshot 2026-01-24 101213

@ZaheerAhmadDev

Copy link
Copy Markdown
Contributor Author

@romani,
https://www.diffchecker.com/FOY0keNx/
https://www.diffchecker.com/Sui4gGUH/
https://www.diffchecker.com/RG9Excgn/
Here is the updated diffchecker links for all the Examples.
Please let me know if any other changes are required.

@romani

romani commented Jan 24, 2026

Copy link
Copy Markdown
Member

GitHub, generate website

@ZaheerAhmadDev ZaheerAhmadDev force-pushed the Fix-XdocsExamplesAstConsistencyTest branch from b8f9ffd to d32e065 Compare January 24, 2026 07:30
@romani

romani commented Jan 24, 2026

Copy link
Copy Markdown
Member

@ZaheerAhmadDev , please do not rebase PR constantly, if you have nothing to change, do not touch it, to let me see that all report generated on latest code and nothing is missing.

@romani romani left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

thanks a lot !!

@romani romani merged commit aa144cd into checkstyle:master Jan 24, 2026
119 checks passed
@romani

romani commented Jan 24, 2026

Copy link
Copy Markdown
Member

@ZaheerAhmadDev , thanks a lot for your big effort on this.
I placed your PR as example for others on how to do this update.

can I ask you to do one more fix for #18435 to make sure you can do it from single try.

If you can help us to improve workding of issue description, it would be awesome

@ZaheerAhmadDev ZaheerAhmadDev deleted the Fix-XdocsExamplesAstConsistencyTest branch January 25, 2026 03:15
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