From 2a46282b2a86a625ee31447a5146ee4452bc93a8 Mon Sep 17 00:00:00 2001 From: Ken Huang Date: Wed, 30 Oct 2024 22:41:10 +0800 Subject: [PATCH] KAFKA-17873: Add description to all packages in the public API (#17605) Reviewers: Mickael Maison --- .../group/api/assignor/package-info.java | 21 +++++++++++++++++++ .../assignment/assignors/package-info.java | 21 +++++++++++++++++++ .../processor/assignment/package-info.java | 21 +++++++++++++++++++ 3 files changed, 63 insertions(+) create mode 100644 group-coordinator/group-coordinator-api/src/main/java/org/apache/kafka/coordinator/group/api/assignor/package-info.java create mode 100644 streams/src/main/java/org/apache/kafka/streams/processor/assignment/assignors/package-info.java create mode 100644 streams/src/main/java/org/apache/kafka/streams/processor/assignment/package-info.java diff --git a/group-coordinator/group-coordinator-api/src/main/java/org/apache/kafka/coordinator/group/api/assignor/package-info.java b/group-coordinator/group-coordinator-api/src/main/java/org/apache/kafka/coordinator/group/api/assignor/package-info.java new file mode 100644 index 00000000000..be49c0f76b9 --- /dev/null +++ b/group-coordinator/group-coordinator-api/src/main/java/org/apache/kafka/coordinator/group/api/assignor/package-info.java @@ -0,0 +1,21 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * 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. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Provides the core functionality and metadata management for consumer group partition assignment. + */ +package org.apache.kafka.coordinator.group.api.assignor; \ No newline at end of file diff --git a/streams/src/main/java/org/apache/kafka/streams/processor/assignment/assignors/package-info.java b/streams/src/main/java/org/apache/kafka/streams/processor/assignment/assignors/package-info.java new file mode 100644 index 00000000000..33262b2e24d --- /dev/null +++ b/streams/src/main/java/org/apache/kafka/streams/processor/assignment/assignors/package-info.java @@ -0,0 +1,21 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * 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. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Provides classes for assigning tasks to stream threads. + */ +package org.apache.kafka.streams.processor.assignment.assignors; diff --git a/streams/src/main/java/org/apache/kafka/streams/processor/assignment/package-info.java b/streams/src/main/java/org/apache/kafka/streams/processor/assignment/package-info.java new file mode 100644 index 00000000000..46bea716ddf --- /dev/null +++ b/streams/src/main/java/org/apache/kafka/streams/processor/assignment/package-info.java @@ -0,0 +1,21 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * 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. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Provides classes and interfaces used to manage and assign tasks within Kafka Streams applications. + */ +package org.apache.kafka.streams.processor.assignment; \ No newline at end of file