Skip to content

Conversation

@S-Saranya1
Copy link
Contributor

Add code examples near the individual method documentation in Java SDK API Refs guide

Motivation and Context

Enhance the Java SDK API Refs documentation to include code examples.

Modifications

  • Added createLinkToCodeExample method to DocumentationUtils.java to generate code example links from example-meta.json

  • Updated OperationDocProvider.java which is in codegen and responsible for generating Javadoc documentation for individual operation methods to include "Code Example" links in method @see sections, appearing after AWS API Documentation links

Testing

  • Ran the inject_examples.py script locally
  • Generated javadoc documentation for test services
  • Opened the package-summary.html files in browser and verified code examples sections are properly displayed
  • Confirmed examples are organized by categories and links work correctly

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document
  • Local run of mvn install succeeds
  • My code follows the code style of this project
  • My change requires a change to the Javadoc documentation
  • I have updated the Javadoc documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
  • My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

  • I confirm that this pull request can be released under the Apache 2 license

@S-Saranya1 S-Saranya1 requested a review from a team as a code owner December 15, 2025 22:58
@sonarqubecloud
Copy link

@S-Saranya1 S-Saranya1 added this pull request to the merge queue Dec 28, 2025
Merged via the queue into master with commit 3d2c167 Dec 28, 2025
44 of 47 checks passed
@github-actions
Copy link

This pull request has been closed and the conversation has been locked. Comments on closed PRs are hard for our team to see. If you need more assistance, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 28, 2025
@S-Saranya1 S-Saranya1 deleted the somepal/add-code-examples-to-individual-methods-docs branch December 30, 2025 07:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants