Skip to content

[BUG] [JavaSpring] Change Dangling package JavaDoc into Regular Comment Block#24278

Merged
wing328 merged 1 commit into
OpenAPITools:masterfrom
anthonyvdotbe:fix-javaspring-javadoc
Jul 14, 2026
Merged

[BUG] [JavaSpring] Change Dangling package JavaDoc into Regular Comment Block#24278
wing328 merged 1 commit into
OpenAPITools:masterfrom
anthonyvdotbe:fix-javaspring-javadoc

Conversation

@anthonyvdotbe

@anthonyvdotbe anthonyvdotbe commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Fixes #24277

PR checklist

  • Read the contribution guidelines.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Switches the auto-generated header from Javadoc (/**) to a block comment (/*) to stop Javadoc warnings in Spring HTTP interface clients. Updates modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-http-interface/httpServiceProxyFactoryInterfacesConfigurator.mustache and regenerates the Petstore sample, fixing #24277.

Written for commit 60883e4. Summary will update on new commits.

Review in cubic

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 1 file

Re-trigger cubic

@wing328

wing328 commented Jul 13, 2026

Copy link
Copy Markdown
Member

what about adding -DskipTests=true to skip the tests when building the project?

@anthonyvdotbe anthonyvdotbe force-pushed the fix-javaspring-javadoc branch from ac8cdb9 to 5172319 Compare July 13, 2026 07:15
@anthonyvdotbe anthonyvdotbe force-pushed the fix-javaspring-javadoc branch from 5172319 to 60883e4 Compare July 13, 2026 07:17
@anthonyvdotbe

Copy link
Copy Markdown
Contributor Author

The samples are updated now.

@Chrimle Chrimle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great find, thanks for the contribution! ❤️

Suggested title:

[BUG] [JavaSpring] Change Dangling package JavaDoc into Regular Comment Block

@anthonyvdotbe anthonyvdotbe changed the title [JavaSpring] Fix Javadoc warning [BUG] [JavaSpring] Change Dangling package JavaDoc into Regular Comment Block Jul 14, 2026
@wing328 wing328 merged commit 7e723e4 into OpenAPITools:master Jul 14, 2026
71 checks passed
@wing328 wing328 added this to the 7.24.0 milestone Jul 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] [JavaSpring] Change Dangling package JavaDoc into Regular Comment Block

3 participants