[jira] [Commented] (ROCKETMQ-114) Add javadoc to codebase

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

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

ASF GitHub Bot commented on ROCKETMQ-114:
-----------------------------------------

Github user shroman commented on a diff in the pull request:

    https://github.com/apache/incubator-rocketmq/pull/80#discussion_r114733797
  
    --- Diff: broker/src/main/java/org/apache/rocketmq/broker/processor/SendMessageProcessor.java ---
    @@ -112,18 +156,21 @@ private RemotingCommand consumerSendMsgBack(final ChannelHandlerContext ctx, fin
                 return response;
             }
     
    +        // Make sure message store of the broker is writable.
             if (!PermName.isWriteable(this.brokerController.getBrokerConfig().getBrokerPermission())) {
                 response.setCode(ResponseCode.NO_PERMISSION);
                 response.setRemark("the broker[" + this.brokerController.getBrokerConfig().getBrokerIP1() + "] sending message is forbidden");
                 return response;
             }
     
    +        // TODO: we should warn client here because OP may carelessly get things wrong here.
    --- End diff --
    
    I think this needs another JIRA issue too.


> Add javadoc to codebase
> -----------------------
>
>                 Key: ROCKETMQ-114
>                 URL: https://issues.apache.org/jira/browse/ROCKETMQ-114
>             Project: Apache RocketMQ
>          Issue Type: Improvement
>            Reporter: Zhanhui Li
>            Assignee: vongosling
>             Fix For: 4.1.0-incubating
>
>
> Quality documentation is critically important to develop and maintain a project. The better the documentation is, the 
> easier it will be for other participants to understand and respond properly.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)