Community
Participate
Working Groups
The org.eclipse.datatools.doc.isv_*.jar of the pre-generated Javadocs packaged in the DTP Extender download package is out of date. Its content does not reflect the latest source. And the jar build label also indicates "1.7.1.200906161800".
Linda, what form are you looking for these lists in? I'm looking at doing things like: o.e.d.connectivity plug-in: org.eclipse.datatools.connectivity.* IN org.eclipse.datatools.connectivity.internal.* OUT o.e.d.connectivity.ui plug-in: org.eclipse.datatools.connectivity.internal.* OUT org.eclipse.datatools.connectivity.ui.* IN Is that what you're looking for?
(In reply to comment #1) Fitz, The sample you have is fine. Thanks.
o.e.d.connectivity plug-in: org.eclipse.datatools.connectivity.* IN org.eclipse.datatools.connectivity.internal.* OUT o.e.d.connectivity.ui plug-in: org.eclipse.datatools.connectivity.internal.* OUT org.eclipse.datatools.connectivity.ui.* IN o.e.d.connectivity.ui.dse plug-in: org.eclipse.datatools.connectivity.ui.dse.* IN o.e.d.connectivity.ui.templates: org.eclipse.datatools.connectivity.ui.templates.* OUT o.e.d.connectivity.db.generic: org.eclipse.datatools.connectivity.db.generic.* IN org.eclipse.datatools.connectivity.db.internal.* OUT o.e.d.connectivity.db.generic.ui: org.eclipse.datatools.connectivity.db.generic.ui* IN org.eclipse.datatools.connectivity.db.internal.* OUT o.e.d.connectivity.apache.derby: org.eclipse.datatools.connectivity.apache.internal.* OUT o.e.d.connectivity.apache.derby.ui: org.eclipse.datatools.connectivity.apache.derby.* OUT o.e.d.connectivity.console.profile: org.eclipse.datatools.connectivity.console.profile.* OUT o.e.d.connectivity.sqm.core: org.eclipse.datatools.connectivity.sqm.core.* IN org.eclipse.datatools.connectivity.sqm.loader.* IN org.eclipse.datatools.connectivity.sqm.internal.* OUT o.e.d.connectivity.sqm.core.ui: org.eclipse.datatools.connectivity.sqm.core.ui.* IN org.eclipse.datatools.connectivity.sqm.internal.ui.* OUT o.e.d.connectivity.sqm.server.ui: org.eclipse.datatools.connectivity.sqm.server.internal.* OUT
As a rule, I don't know why we have such a mix of public/private (internal) packages in the Enablement plug-ins. But it appears that you should be able to use this basic pattern for all of them: [Include] If the package name doesn't include "internal" [Exclude] If the package name includes "internal"
The list of Javadoc packages for the ODA area, i.e. All ODA framework plugins with "org.eclipse.datatools.connectivity.oda*" prefix [Exclude] org.eclipse.datatools.connectivity.oda*.impl org.eclipse.datatools.connectivity.oda*.nls org.eclipse.datatools.connectivity.oda*.internal* In addition, excludes the following packages: Plugin: org.eclipse.datatools.connectivity.oda.consumer [Exclude] org.eclipse.datatools.connectivity.oda.consumer.helper Plugin: org.eclipse.datatools.connectivity.oda.profile [Exclude] org.eclipse.datatools.connectivity.oda.profile.provider [Exclude] all the following ODA plugins: org.eclipse.datatools.connectivity.oda.template.ui org.eclipse.datatools.connectivity.oda.flatfile* org.eclipse.datatools.enablement.oda.*
The Modelbase plugins are easy: [Exclude] org.eclipse.datatools.modelbase.*.impl Include all the other packages.
Here's the story for sqldevtools: As a general rule, should eclude packages with "internal" in the name. But there are lots of exceptions, as noted below. -- org.eclipse.datatools.sqltools.data.core and org.eclipse.datatools.sqltools.data.ui In these plugins, *every* package is marked internal. But then they are all listed in Export-Package list in the MANIFEST.MF. Go figure. To quote the character Syndrome in "The Incredibles": When everyone is special, then nobody is! We should go ahead and publish the javadoc for all the package in these two plugins. -- org.eclipse.datatools.sqltools.db.generic This plugin uses the "x-friends" directive to limit export of all packages to the plugin o.e.d.sqltools.db.derby. So looks like we shouldn't javadoc this plugin. -- org.eclipse.datatools.sqltools.db.generic.test Don't javadoc this one, since it's a test plugin. -- org.eclipse.datatools.sqltools.debugger.core The only "internal" package here (o.e.d.sqltools.debugger.core.internal) is listed in the Export-Package list, so we should go ahead and javadoc it. -- org.eclipse.datatools.sqltools.editor.core All packages are listed in the Export-Package section, including the internal ones (though some of them have "x-friends"), so we should javadoc everything. -- org.eclipse.datatools.sqltools.parsers.sql.test, org.eclipse.datatools.sqltools.parsers.sql.query.test, org.eclipse.datatools.sqltools.parsers.sql.xml.query.test Don't javadoc these, since they are test plugins. -- org.eclipse.datatools.sqltools.plan.junittest and org.eclipse.datatools.sqltools.result.junittest Don't javadoc these, since they are test plugins. -- org.eclipse.datatools.sqltools.result All packages are listed in the Export-Package section, including the internal ones, so we should javadoc everything. -- org.eclipse.datatools.sqltools.routineeditor The package "...routineeditor.internal" is in the Export-Package list, but "...routineeditor.internal.result" is not. They both contain Message.java and messages.properties, so I don't know why one is exported and one isn't. In this case, I think we should not javadoc either of the internal packages. -- org.eclipse.datatools.sqltools.schemaobjecteditor.ui The package "...schemaobjecteditor.ui.internal.ui" is included in the Export-Package list, but none of the other "interal" packages are. The classes in the internal.ui package seem like ones that should be available for extenders, so I think we should javadoc this one but not the others. -- org.eclipse.datatools.sqltools.sqleditor A real mixed bag here, with about half of the "internal" packages being exported. Might as well javadoc everything if we can't have the javadoc conform to the Export-Package list. -- org.eclipse.datatools.sqltools.tabledataeditor No consistency in this one at all. Might as well javadoc everything.
Initial version has been delivered in 1.9.0 I-build v20101210-1629. Please have a review. Note that, to check the all available packages, please choose either package first, then click "Overview" to check all packages. I have update the top-level toc file after your review.
Correction: I will update the top-level toc file after your review.
*** Bug 332331 has been marked as a duplicate of this bug. ***
Set as fixed.
(In reply to comment #8) Xiaoying, In reviewing the generated Javadoc for the ODA packages, I realized that I have missed a couple from the Javadoc exclusion list. The following should be excluded as well: package org.eclipse.datatools.connectivity.oda.design.ui.profile.db.wizards bundle org.eclipse.datatools.connectivity.oda.profile I have also cleaned up some Javadoc comments in ODA framework packages; tagged with v201012150952. Thanks.
Reopen for updates per comment #12
Fixed in 1.8.2.v20101217-0800
I didn't review absolutely everything in the Connectivity javadoc, but it looks good to me as far as the packages we included goes. Thanks for updating the javadocs Xiaoying!
The exclude/include packages can be configured in: modelbase.package.properties, sqltools.package.properties, enablement.package.properties, connectivity.package.properties, which locates under org.eclipse.datatools.build/org.eclipse.datatools.doc.isv
