[jira] [Commented] (KAFKA-3362) Update protocol schema and field doc strings

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/KAFKA-3362?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16076459#comment-16076459 ] 

ASF GitHub Bot commented on KAFKA-3362:
---------------------------------------

GitHub user andrasbeni opened a pull request:

    https://github.com/apache/kafka/pull/3495

    KAFKA-3362: Update protocol schema and field doc strings

    Added doc to protocol fields

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/andrasbeni/kafka KAFKA-3362

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/kafka/pull/3495.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #3495
    
----
commit ad144271aa8a491faa31be998bf2bfa32ac87847
Author: Andras Beni <an...@cloudera.com>
Date:   2017-06-22T07:10:43Z

    KAFKA-3362: Update protocol schema and field doc strings
    
    Added doc to protocol fields

----


> Update protocol schema and field doc strings
> --------------------------------------------
>
>                 Key: KAFKA-3362
>                 URL: https://issues.apache.org/jira/browse/KAFKA-3362
>             Project: Kafka
>          Issue Type: Sub-task
>            Reporter: Grant Henke
>            Assignee: Andras Beni
>
> In KAFKA-3361, auto generation of docs based on the definitions in Protocol.java was added. There are some inconsistencies and missing information in the docs strings in the code vs. the [wiki page|https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol]. 
> The code documentation strings should be reviewed and updated to be complete and accurate. 



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)