Skip to content

Issue #13796: clarify AnnotationLocation same-line annotation precedence#18388

Merged
romani merged 1 commit into
checkstyle:masterfrom
dhruv-38:doc-annotationlocation-clarification
Jan 10, 2026
Merged

Issue #13796: clarify AnnotationLocation same-line annotation precedence#18388
romani merged 1 commit into
checkstyle:masterfrom
dhruv-38:doc-annotationlocation-clarification

Conversation

@dhruv-38

Copy link
Copy Markdown
Contributor

Fixes #13796

This PR clarifies the AnnotationLocation documentation by explaining that
allowSamelineMultipleAnnotations has a dominant effect over other same line
annotation properties.

Documentation only change. No logic changes.

@dhruv-38 dhruv-38 force-pushed the doc-annotationlocation-clarification branch from 127df61 to 683c4da Compare December 20, 2025 11:59
@vivek-0509

Copy link
Copy Markdown
Member

Hey @dhruv-38 ,
The CI is failing because the .xml file was edited directly, but xdocs are auto generated from the Java source.
To fix this, add the clarifying paragraph to the Java source Javadoc in AnnotationLocationCheck.java
Then regenerate xdocs with mvn clean site -Pno-validations and commit the generated annotationlocation.xml. The content will flow from the Java source → template macro → generated XML.

@dhruv-38

Copy link
Copy Markdown
Contributor Author

@vivek-0509 I have added to the Javadoc and then run the mvn clean site -Pno-validations but it does not change or generate the annotationlocation.xml

@vivek-0509

vivek-0509 commented Dec 21, 2025

Copy link
Copy Markdown
Member

mvn clean site -Pno-validations

run mvn clean verify after adding it in the AnnotationLocationCheck i tried it locally it will work.

@dhruv-38

Copy link
Copy Markdown
Contributor Author

run mvn clean verify after adding it in the AnnotationLocationCheck i tried it locally it will work.

image see i have added in the Javadoc and ran this command "mvn clean verify", Where should i see the changes ? i mean in which location and which file? because i cannot see any changes.

@vivek-0509

Copy link
Copy Markdown
Member

@dhruv-38 add this para to the class level javadoc around line 72 not to the field javadoc then run mvn clean verify , then check git status it will show three files changed , commit your changes and push after clean build.

@romani

romani commented Dec 22, 2025

Copy link
Copy Markdown
Member

Please read and watch videos at Starting_Development.
Please make CI green.

@dhruv-38 dhruv-38 force-pushed the doc-annotationlocation-clarification branch from 327ad4b to f947c08 Compare December 22, 2025 07:09
@dhruv-38

Copy link
Copy Markdown
Contributor Author

Now all the CI is green. Do i need to do any thing else?

@romani

romani commented Dec 26, 2025

Copy link
Copy Markdown
Member

@dhruv-38 , please use commit prefix as Issue #13796: ..... to let commit be bound to issue firmly.

@romani

romani commented Dec 26, 2025

Copy link
Copy Markdown
Member

GitHub, generate website

@romani

romani commented Dec 26, 2025

Copy link
Copy Markdown
Member

all other is good.
after commit message is changed, we good to merge

@dhruv-38 dhruv-38 force-pushed the doc-annotationlocation-clarification branch from f947c08 to 252bb26 Compare December 26, 2025 05:09
@dhruv-38 dhruv-38 changed the title doc: clarify AnnotationLocation same-line annotation precedence Issue #13796: clarify AnnotationLocation same-line annotation precedence Dec 26, 2025
@romani romani force-pushed the doc-annotationlocation-clarification branch from 252bb26 to 55ea01c Compare December 26, 2025 05:41
@romani

romani commented Dec 26, 2025

Copy link
Copy Markdown
Member

@dhruv-38 , single commit please
And rebase on latest our master branch

@dhruv-38

Copy link
Copy Markdown
Contributor Author

ok, should i create a new pr?

@vivek-0509

Copy link
Copy Markdown
Member

@dhruv-38
No need to create a new PR.
Please rebase your branch and squash all commits into a single commit.

You can refer to the following documentation for instructions on how to rebase:
https://checkstyle.org/beginning_development.html#Starting_Development

@romani

romani commented Dec 26, 2025

Copy link
Copy Markdown
Member

Please read and watch videos at Starting_Development.
Videos shows how to squash

@dhruv-38 dhruv-38 force-pushed the doc-annotationlocation-clarification branch from 55ea01c to c244605 Compare December 26, 2025 06:51
@dhruv-38

Copy link
Copy Markdown
Contributor Author

@romani
I rebased on latest and squashed into a single commit.
The two CI is failing since i did'nt changed any new code, but previously the CI was green. Did I do something wrong again?
I am sorry for all these messed up things and all the clutters. I am just getting familiar to it. Thanks for you time.

@dhruv-38

Copy link
Copy Markdown
Contributor Author

@vivek-0509 why its failing again?

@vivek-0509

Copy link
Copy Markdown
Member

@vivek-0509 why its failing again?

not related to your changes , just need to run the CI again.

@romani romani merged commit df31a58 into checkstyle:master Jan 10, 2026
72 checks passed
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.

Give more clarity on xdocs for AnnotationLocation

3 participants