gharris1727 opened a new pull request, #12936: URL: https://github.com/apache/kafka/pull/12936
Signed-off-by: Greg Harris <greg.har...@aiven.io> Split off from #12895 to target only Streams packages. There are currently no descriptions of packages in the javadocs, which can be intimidating to new users that look at the documentation and see a wall of raw package names. An example of this can be seen here: https://kafka.apache.org/31/javadoc/ This change adds the following package descriptions based on a best-effort reading of the existing javadocs. Please feel free to correct any factual errors in the proposed descriptions, I am not asserting that these descriptions are currently accurate. Currently the only package with new descriptions is clients, and I will be adding commits to this PR to address missing descriptions in the other packages (connect, core, streams) For clarity of review, I'll summarize the new descriptions in a table. This summary may become stale by accident, so please be sure to view the diff itself or build the changes locally with `./gradlew javadoc`. Package | Description --- | --- org.apache.kafka.streams|Provides the Kafka Streams library for building streaming data applications. org.apache.kafka.streams.errors|Provides common exception classes for Streams applications. org.apache.kafka.streams.kstream|Provides high-level abstractions of streaming data and computation over that streaming data. org.apache.kafka.streams.processor|Provides low-level abstractions of streaming data and computation over that streaming data. org.apache.kafka.streams.processor.api|Provides low-level abstractions of streaming data and computation over that streaming data. org.apache.kafka.streams.query|Provides API for extracting data from a Streams application. org.apache.kafka.streams.state|Provides interfaces for managing the intermediate state of a stateful streams application. org.apache.kafka.streams.test|Provides classes for testing Streams applications with mocked inputs. ### Committer Checklist (excluded from commit message) - [ ] Verify design and implementation - [ ] Verify test coverage and CI build status - [ ] Verify documentation (including upgrade notes) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
