Skip to content

Add Javadoc since for UseMainMethod #32568

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
Closed
wants to merge 2 commits into from
Closed

Add Javadoc since for UseMainMethod #32568

wants to merge 2 commits into from

Conversation

izeye
Copy link
Contributor

@izeye izeye commented Oct 2, 2022

This PR adds Javadoc @since tag for SpringBootTest.UseMainMethod.

See gh-22405

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Oct 2, 2022
@izeye
Copy link
Contributor Author

izeye commented Oct 2, 2022

I pushed a8eb298 as the Spring Java Format doesn't seem to support this case yet.

@wilkinsona
Copy link
Member

Thanks, @izeye. Without a8eb298, I see a failure like this:

> Task :spring-boot-project:spring-boot-test:checkstyleMain
[ant:checkstyle] [ERROR] /Users/awilkinson/dev/spring-projects/spring-boot/main/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/context/SpringBootTest.java:191:19: Javadoc @since tag should not be used on private classes. [SpringJavadoc]

Do you see the same? Curiously, this should work due to the changes made for spring-io/spring-javaformat#132.

@wilkinsona wilkinsona added the status: waiting-for-feedback We need additional information before we can continue label Oct 3, 2022
@wilkinsona
Copy link
Member

And, of course, shortly after making that comment I realised what's going on. It's the difference between interface and @interface, that is to say an interface definition and an annotation definition.

@philwebb
Copy link
Member

philwebb commented Oct 3, 2022

See spring-io/spring-javaformat#344

@philwebb philwebb added for: merge-with-amendments Needs some changes when we merge type: task A general task and removed status: waiting-for-feedback We need additional information before we can continue status: waiting-for-triage An issue we've not yet triaged labels Oct 3, 2022
@philwebb philwebb added this to the 3.0.x milestone Oct 3, 2022
@philwebb
Copy link
Member

philwebb commented Oct 3, 2022

If we wait for a javaformat release we can amend the PR to not need the checkstyle exclusion.

@wilkinsona wilkinsona added type: documentation A documentation update and removed type: task A general task labels Oct 6, 2022
wilkinsona pushed a commit that referenced this pull request Oct 6, 2022
@izeye @wilkinsona
Add Javadoc since for UseMainMethod
64132af 
See gh-32568
@wilkinsona wilkinsona closed this in 1a2cf83 Oct 6, 2022
@wilkinsona wilkinsona modified the milestones: 3.0.x, 3.0.0-RC1 Oct 6, 2022
@wilkinsona
Copy link
Member

Thank you, @izeye!

@izeye izeye deleted the since branch October 6, 2022 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
for: merge-with-amendments Needs some changes when we merge type: documentation A documentation update
Projects
None yet
Milestone
3.0.0-RC1
Development

Successfully merging this pull request may close these issues.
4 participants
@izeye @wilkinsona @philwebb @spring-projects-issues