Skip to content

Fix doc warnings in java okhttp-gson client#23557

Merged
wing328 merged 1 commit intomasterfrom
minor-fix-doc
Apr 15, 2026
Merged

Fix doc warnings in java okhttp-gson client#23557
wing328 merged 1 commit intomasterfrom
minor-fix-doc

Conversation

@wing328
Copy link
Copy Markdown
Member

@wing328 wing328 commented Apr 15, 2026

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • 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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • 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

Fix Javadoc warnings in the Java okhttp-gson client by escaping generics and cleaning up oneOf/anyOf docs. Added missing @SuppressWarnings("unchecked") on getters; no runtime behavior changes.

  • Bug Fixes
    • Escape angle brackets in generated Javadoc (switch {{{...}}} to {{...}}; render <...> for generics).
    • Update anyof_model.mustache and oneof_model.mustache to use {{dataType}} and correct return/throws text.
    • Add @SuppressWarnings("unchecked") to typed getters and regenerate samples.

Written for commit c7e14cf. Summary will update on new commits.

@wing328 wing328 changed the title fix doc warning in java okhttp-gson client Fix doc warnings in java okhttp-gson client Apr 15, 2026
@wing328 wing328 added this to the 7.22.0 milestone Apr 15, 2026
@wing328 wing328 marked this pull request as ready for review April 15, 2026 12:33
Copy link
Copy Markdown
Contributor

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

Choose a reason for hiding this comment

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

No issues found across 27 files

@wing328 wing328 merged commit 294eaa6 into master Apr 15, 2026
166 checks passed
@wing328 wing328 deleted the minor-fix-doc branch April 15, 2026 12:44
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.

1 participant