drill-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jason Altekruse (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DRILL-3461) Need to add javadocs to class where they are missing
Date Mon, 06 Jul 2015 21:55:04 GMT

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

Jason Altekruse commented on DRILL-3461:
----------------------------------------

[~tdunning] I completely agree with the intent of this JIRA, Drill is lacking documentation
just about everywhere, and it needs to be fixed if we expect anyone to contribute. One clarification
I would like to offer in regards the lists you have posted so far. These interpreter classes
have been removed from Drill, unfortunately it looks like the way I made this change to the
POM, it was not deleting the old files even when using mvn clean. This entire module should
have been deleted, it looks like we have an orphaned test file from a later merge still in
the directory, but I don't think this is being run as there is not a corresponding pom file
anymore.

I do apologize for the confusion, but a fresh checkout of the Drill source tree and install
will not generate these classes. I'm not sure if there is a way to make maven remove files
from old modules automatically, but I will try to take a look at this to prevent any further
confusion.

The classes were automatic rewrites of all of the functions that were previously being generated
during the build, but this functionality has been replaced by a reflection based approach
the prevents the need to generate so many extra classes.

All of these points aside, I want to be a part of this effort to get the bring the Drill documentation
up to a decent standard. I have posted a message to the list looking for a final review of
the package level docs I tried submitting a few months ago. I will try to do what I can to
collect knowledge from the right people to allow documentation to be written, even if the
team is too busy to write a lot themselves.

> Need to add javadocs to class where they are missing
> ----------------------------------------------------
>
>                 Key: DRILL-3461
>                 URL: https://issues.apache.org/jira/browse/DRILL-3461
>             Project: Apache Drill
>          Issue Type: Bug
>            Reporter: Ted Dunning
>         Attachments: no-comments.txt, no-javadoc-no-comments.txt, no-javadocs.txt
>
>
> 1220 classes in Drill have no Javadocs whatsoever.  I will attach a detailed list.
> Some kind of expression of intent and basic place in the architecture should be included
in all classes.
> The good news is that at least there are 1838 (1868 in 1.1.0 branch) classes that have
at least some kind of javadocs. 
> I would be happy to help write comments, but I can't figure out what these classes do.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message