docs: Add package-level Javadoc for gateway core packages#4121
Open
shiguangtong wants to merge 1 commit intospring-cloud:mainfrom
Open
docs: Add package-level Javadoc for gateway core packages#4121shiguangtong wants to merge 1 commit intospring-cloud:mainfrom
shiguangtong wants to merge 1 commit intospring-cloud:mainfrom
Conversation
- Add comprehensive Javadoc for org.springframework.cloud.gateway.discovery package describing service discovery integration capabilities - Add Javadoc for org.springframework.cloud.gateway.event package documenting event-driven gateway lifecycle management - Add Javadoc for org.springframework.cloud.gateway.filter package explaining filter types and common implementations These additions improve code documentation and help developers understand the purpose and usage of each package in the Spring Cloud Gateway framework.
ryanjbaxter
requested changes
Mar 30, 2026
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
Contributor
|
Please sign your commits so the DCO check passes |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
This PR adds comprehensive package-level Javadoc documentation for three core Spring Cloud Gateway packages that were previously marked with TODO comments.
Changes
Motivation and Context
These documentation additions help developers understand the purpose and usage of each package in the Spring Cloud Gateway framework. They resolve the TODO comments that were previously in these files.
Type of Change
Checklist
Stats