You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@drill.apache.org by "CoolGuy (Jira)" <ji...@apache.org> on 2021/08/17 13:45:00 UTC

[jira] [Created] (DRILL-7987) Missing Javadoc

CoolGuy created DRILL-7987:
------------------------------

             Summary: Missing Javadoc
                 Key: DRILL-7987
                 URL: https://issues.apache.org/jira/browse/DRILL-7987
             Project: Apache Drill
          Issue Type: Wish
            Reporter: CoolGuy


Hello! I find in your [Contribution Guidelines|http://drill.apache.org/docs/apache-drill-contribution-guidelines/] that 
??All public classes and methods should have informative Javadoc comments.??

However, I still witness some public classes without Javadocs, e.g.,
* protocol/src/main/java/org/apache/drill/exec/proto/BitData.java
* exec/java-exec/src/main/java/org/apache/drill/exec/physical/impl/MergingReceiverCreator.java
* exec/java-exec/src/main/java/org/apache/drill/exec/physical/impl/common/HashTable.java
......

I also find likely missing Javadoc for public methods in the following files:
* drill-yarn/src/main/java/org/apache/drill/yarn/core/YarnRMClient.java
* protocol/src/main/java/org/apache/drill/exec/proto/SchemaBitControl.java
......

Would you like to add Javadoc for these methods or classes, or they are just not that important?
If there is anything I can help with?




--
This message was sent by Atlassian Jira
(v8.3.4#803005)