[
https://issues.apache.org/jira/browse/DRILL-3160?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14733167#comment-14733167
]
Daniel Barclay (Drill) commented on DRILL-3160:
-----------------------------------------------
Okay, I got it running now with the PermGen size increase.
Can you adjust the configuration to include only packages
{{org.apache.drill.jdbc}} and {{org.apache.drill.jdbc.proxy}} (thereby
excluding package {{org.apache.drill.jdbc.impl}})?
The current configuration includes documentation for package
{{org.apache.drill.jdbc.impl}} in the output. However, that package is not
part of the published interface of the JDBC driver, so it shouldn't show up in
this Javadoc (since this Javadoc is for that published interface, for
developers of code calling Drill's JDBC API).
(Ignoring the tracing proxy driver for the moment, the published interface of
the JDBC driver currently consists only of package {{org.apache.drill.jdbc}}.
As for the tracing proxy driver, although it's not officially supported, the
instructions on using it are currently in Javadoc comments on public class
{{org.apache.drill.jdbc.proxy.TracingProxyDriver}}, so package
{{org.apache.drill.jdbc.proxy}} should, at least currently, remain in the
Javadoc.))
If possible, please use inclusion (of {{org.apache.drill.jdbc}} and
{{org.apache.drill.jdbc.proxy}}) rather than exclusion (of
{{org.apache.drill.jdbc.impl}}).
(The parts of Drill's JDBC API that are JDBC extensions (e.g.,
{{DrillConnection.getClient()}}) refer to, or will refer to, types
(interfaces/class) in other parts of Drill. Eventually, the Drill's JDBC
published-interface Javadoc should include those types. We'll probably want to
do that by including specific things rather than including big chunks and then
trying to exclude all unwanted things.)
> 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.2.0
>
> Attachments:
> DRILL-3160-Make-JDBC-Javadoc-documentation-available.patch
>
>
> 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
(v6.3.4#6332)
