You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "Israel Ekpo (Jira)" <ji...@apache.org> on 2021/07/06 20:11:00 UTC
[jira] [Updated] (KAFKA-12644) Add Missing Class-Level Javadoc to
Descendants of org.apache.kafka.common.errors.ApiException
[ https://issues.apache.org/jira/browse/KAFKA-12644?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Israel Ekpo updated KAFKA-12644:
--------------------------------
Summary: Add Missing Class-Level Javadoc to Descendants of org.apache.kafka.common.errors.ApiException (was: Add Missing Class-Level Javadoc to Decendants of org.apache.kafka.common.errors.ApiException)
> Add Missing Class-Level Javadoc to Descendants of org.apache.kafka.common.errors.ApiException
> ---------------------------------------------------------------------------------------------
>
> Key: KAFKA-12644
> URL: https://issues.apache.org/jira/browse/KAFKA-12644
> Project: Kafka
> Issue Type: Improvement
> Components: clients, documentation
> Affects Versions: 3.0.0, 2.8.1
> Reporter: Israel Ekpo
> Assignee: Israel Ekpo
> Priority: Blocker
> Labels: documentation
> Fix For: 3.0.0, 2.8.1
>
>
> 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
--
This message was sent by Atlassian Jira
(v8.3.4#803005)