-
Notifications
You must be signed in to change notification settings - Fork 976
Add code example links to individual method documentation in API refs guide #6626
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.
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
Merged
S-Saranya1
merged 15 commits into
master
from
somepal/add-code-examples-to-individual-methods-docs
Dec 28, 2025
Merged
Add code example links to individual method documentation in API refs guide #6626
S-Saranya1
merged 15 commits into
master
from
somepal/add-code-examples-to-individual-methods-docs
Dec 28, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zoewangg
requested changes
Dec 16, 2025
codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java
Outdated
Show resolved
Hide resolved
12 tasks
zoewangg
reviewed
Dec 19, 2025
codegen/src/main/java/software/amazon/awssdk/codegen/docs/OperationDocProvider.java
Outdated
Show resolved
Hide resolved
...n/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/PackageInfoGeneratorTasks.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java
Outdated
Show resolved
Hide resolved
...n/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/PackageInfoGeneratorTasks.java
Show resolved
Hide resolved
...n/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/PackageInfoGeneratorTasks.java
Show resolved
Hide resolved
...n/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/PackageInfoGeneratorTasks.java
Outdated
Show resolved
Hide resolved
...n/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/PackageInfoGeneratorTasks.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java
Outdated
Show resolved
Hide resolved
zoewangg
reviewed
Dec 23, 2025
...n/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/PackageInfoGeneratorTasks.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/ExampleMetadataProvider.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/ExampleMetadataProvider.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/ExampleMetadataProvider.java
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/ExampleMetadataProvider.java
Outdated
Show resolved
Hide resolved
codegen/src/main/java/software/amazon/awssdk/codegen/internal/ExampleMetadataProvider.java
Show resolved
Hide resolved
codegen/src/test/java/software/amazon/awssdk/codegen/docs/OperationDocProviderTest.java
Outdated
Show resolved
Hide resolved
...c/test/java/software/amazon/awssdk/codegen/emitters/tasks/PackageInfoGeneratorTasksTest.java
Show resolved
Hide resolved
codegen/src/test/resources/software/amazon/awssdk/codegen/emitters/tasks/s3-package-info.java
Outdated
Show resolved
Hide resolved
zoewangg
approved these changes
Dec 23, 2025
|
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.



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
createLinkToCodeExamplemethod toDocumentationUtils.javato generate code example links from example-meta.jsonUpdated
OperationDocProvider.javawhich 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 linksTesting
Screenshots (if appropriate)
Types of changes
Checklist
mvn installsucceedsscripts/new-changescript and following the instructions. Commit the new file created by the script in.changes/next-releasewith your changes.License