[jira] Commented: (DERBY-138) Public javadoc should include the org.apache.derby.diag package to show usage of LockTable and other public VTI's

["Daniel John Debrunner (JIRA)" <de...@db.apache.org>]

     [ http://issues.apache.org/jira/browse/DERBY-138?page=comments#action_66369 ]
     
Daniel John Debrunner commented on DERBY-138:
---------------------------------------------

I don't believe these classes should be in the public Javadoc api. I believe the diagnostic vtis should be documented in the manuals but not as java classes. This is because they are not to be used as java classes, only as VTIs within the context of a SQL statement.
I hoping to do some work in the future that allows a table alias to map to a vti, so that the diagnostic tables would be something like

select * from SYSDIAG.LOCKTABLE

and thus the vti implementation details are hidden.


> Public javadoc should include the org.apache.derby.diag package to show usage of LockTable and other public VTI's
> -----------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-138
>          URL: http://issues.apache.org/jira/browse/DERBY-138
>      Project: Derby
>         Type: Bug
>   Components: Documentation
>     Versions: 10.0.2.1, 10.0.2.0, 10.0.2.2
>     Reporter: Kathey Marsden
>     Assignee: Dyre Tjeldvoll
>     Priority: Minor
>  Attachments: derby-138.178562.diff, derby-138.178562.stat, derby-138.jpg, derbyall_report.txt
>
> The LockTable VTI, ErrorMessage and other public diagnostic VTI's in the org.apache.derby.diag package are not available in the public javadoc.  They should be added to provide documentation.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira