[
https://issues.apache.org/jira/browse/KAFKA-3365?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Grant Henke updated KAFKA-3365:
-------------------------------
Description:
Currently the type class does not allow a documentation field. This means we
can't auto generate a high level documentation summary for each type in the
protocol. Adding this field and updating the generated output would be valuable.
was:
Currently the Schema type does not allow a documentation field. This means we
can't auto generate a high level documentation summary for each version of a
schema. Adding this field, the relevant docs from the [wiki
page|https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol]
and updating the generated output would be valuable.
> Add a documentation field for types and update doc generation
> -------------------------------------------------------------
>
> Key: KAFKA-3365
> URL: https://issues.apache.org/jira/browse/KAFKA-3365
> Project: Kafka
> Issue Type: Sub-task
> Reporter: Grant Henke
> Fix For: 0.10.0.0
>
>
> Currently the type class does not allow a documentation field. This means we
> can't auto generate a high level documentation summary for each type in the
> protocol. Adding this field and updating the generated output would be
> valuable.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
