You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "Konstantine Karantasis (Jira)" <ji...@apache.org> on 2021/08/10 20:22:00 UTC

[jira] [Commented] (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:comment-tabpanel&focusedCommentId=17396873#comment-17396873 ] 

Konstantine Karantasis commented on KAFKA-12644:
------------------------------------------------

Given that at this point in time for 3.0 we are focusing exclusively on blocker issues and stabilization fixes (e.g. tests), I'll go ahead and push the target fix version for this issue to 3.0.1 and 3.1.0.

> 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: Major
>              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)