[KAFKA-12644] Add Missing Class-Level Javadoc to Descendants of org.apache.kafka.common.errors.ApiException

• Type: Improvement
• Status: In Progress
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 2.8.1, 3.0.0
• Component/s: clients, documentation
• Labels: documentation
• Flags: Important
• Assignee: Israel Ekpo
• Reporter: Israel Ekpo
• Due: 26/Apr/21
• Created: 09/Apr/21 18:31
• Updated: 04/Apr/22 18:36

Description

I noticed that class-level Javadocs are missing from some classes in the org.apache.kafka.common.errors package. This issue is for tracking the work of adding the missing class-level javadocs for those Exception classes.

https://kafka.apache.org/27/javadoc/org/apache/kafka/common/errors/package-summary.html

https://github.com/apache/kafka/tree/trunk/clients/src/main/java/org/apache/kafka/common/errors

Basic class-level documentation could be derived by mapping the error conditions documented in the protocol

https://kafka.apache.org/protocol#protocol_constants

Issue Links

• links to: GitHub Pull Request #10741