drill-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Daniel Barclay (Drill) (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DRILL-3160) Make JDBC Javadoc documentation available to users
Date Fri, 10 Jul 2015 05:05:04 GMT

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

Daniel Barclay (Drill) commented on DRILL-3160:

Notes for when implementing:

The [published|http://martinfowler.com/bliki/PublishedInterface.html]  interface of the JDBC
driver is package {{org.apache.drill.jdbc}}.  Specifically:
- That includes all types (interfaces and classes) in package {{org.apache.drill.jdbc}}. 
(There shouldn't be any non-public types in that package, so there shouldn't be any need to
exclude any.)
- That includes public and any protected members, but not any package-private or private members.
- That does not include any child packages of {{package org.apache.drill}}.
- That includes only the {{src/main/java}} source tree in the {{drill-jdbc}} module.  (It
excludes the {{src/test/java}} subtree.)

Something to resolve, probably later:

The published interface of the JDBC driver includes, in the declaration of {{org.apache.drill.jdbc.DrillConnection.getClient()}},
a reference to {{org.apache.drill.exec.client.DrillClient}} (from the {{drill-java-exec module}}).

Eventually, the published-interface Javadoc documentation for Drill as a whole needs to include
{{DrillClient}} and probably everything public or protected that it leads to,

> Make JDBC Javadoc documentation available to users
> --------------------------------------------------
>                 Key: DRILL-3160
>                 URL: https://issues.apache.org/jira/browse/DRILL-3160
>             Project: Apache Drill
>          Issue Type: Bug
>          Components: Tools, Build & Test
>            Reporter: Daniel Barclay (Drill)
>            Assignee: Aditya Kishore
>             Fix For: 1.3.0
> The existing Javadoc documentation (source) for Drill JDBC classes/interfaces such as
org.apache.drill.jdbc.Driver and org.apache.drill.jdbc.DrillResultSet is not generated into
documentation pages and packaged for users by the current Maven build scripts.

This message was sent by Atlassian JIRA

View raw message