diff --git a/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/discovery/package-info.java b/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/discovery/package-info.java index f454e0ee68..75227aea45 100644 --- a/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/discovery/package-info.java +++ b/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/discovery/package-info.java @@ -15,9 +15,29 @@ */ /** - * TODO: package javadoc. + * Service discovery integration for Spring Cloud Gateway. + * + *

+ * This package provides support for dynamic route discovery using Spring Cloud's + * {@link org.springframework.cloud.client.discovery.DiscoveryClient}. It enables + * automatic route creation based on registered service instances in service registries + * such as Eureka, Consul, or Kubernetes. + *

+ * + *

+ * Key components: + *

+ *

+ * + * @see org.springframework.cloud.client.discovery.DiscoveryClient + * @see org.springframework.cloud.gateway.route.RouteDefinitionLocator */ @NullMarked package org.springframework.cloud.gateway.discovery; -import org.jspecify.annotations.NullMarked; +import org.jspecify.annotations.NullMarked; \ No newline at end of file diff --git a/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/event/package-info.java b/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/event/package-info.java index fe5c006f88..092e99cad5 100644 --- a/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/event/package-info.java +++ b/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/event/package-info.java @@ -15,9 +15,33 @@ */ /** - * TODO: package javadoc. + * Event publishing and handling for Spring Cloud Gateway. + * + *

+ * This package provides event-driven capabilities for gateway lifecycle and route + * management. It enables applications to react to gateway events such as route + * refreshes, route definitions being added or removed, and other gateway state changes. + *

+ * + *

+ * Key components: + *

+ *

+ * + *

+ * Applications can listen to these events by implementing + * {@link org.springframework.context.ApplicationListener} or using the + * {@link org.springframework.context.event.EventListener} annotation. + *

+ * + * @see org.springframework.context.ApplicationEvent + * @see org.springframework.context.ApplicationListener */ @NullMarked package org.springframework.cloud.gateway.event; -import org.jspecify.annotations.NullMarked; +import org.jspecify.annotations.NullMarked; \ No newline at end of file diff --git a/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/filter/package-info.java b/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/filter/package-info.java index f89e5daf63..50c0e092bf 100644 --- a/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/filter/package-info.java +++ b/spring-cloud-gateway-server-webflux/src/main/java/org/springframework/cloud/gateway/filter/package-info.java @@ -9,15 +9,46 @@ * * 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. + * WITHOUT WARRANTIES or conditions of ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** - * TODO: package javadoc. + * Gateway filters for request and response processing. + * + *

+ * This package contains the core filter implementations for Spring Cloud Gateway. + * Filters are used to modify incoming requests and outgoing responses as they pass + * through the gateway. They can be applied globally or scoped to specific routes. + *

+ * + *

+ * Filter types include: + *

+ *

+ * + *

+ * Common filter implementations: + *

+ *

+ * + * @see org.springframework.cloud.gateway.filter.GatewayFilter + * @see org.springframework.cloud.gateway.filter.GlobalFilter */ @NullMarked package org.springframework.cloud.gateway.filter; -import org.jspecify.annotations.NullMarked; +import org.jspecify.annotations.NullMarked; \ No newline at end of file