Community
Participate
Eclipse IDE
in 3.1 the JavaDoc for EclipseStarter is missing from the API Reference Help doc. This is likely a problem with the JavaDoc generation scripts.
Could you please verify what I missed here?
The platformOptions file needs to be updated to include the org.eclipse.core.runtime.adapter package and sourcepath. Will also need to update the topics_Reference.xml. Will update in 3.2 and 3.1 maintenance streams.
Is a package.html required? I don't see one in eclipseAdapter/src/org/eclipse/core/runtime/adatper.
Added entries in platformOptions and topic_Reference.xml.
Moving back to Platform Core to add package.html or close.
There was a typo in the topics_Reference.xml and javadoc options files where "adaptor" was mispelled. Fixed in 3.1 maintenance and HEAD streams.
Sonia, Jeff - the comments below seem to indicate this bug is resolved for 3.1.1. Is that the case? It's still marked as New. Thanks.
I can confirm that the javadoc for this class is being generated, however there is no package description for org.eclipse.core.runtime.adaptor. (Help -> Platform Plug-in Developer Guide -> Reference -> API Reference).
I noticed no package description too. Do you know where that comes from (i.e. does Core have to change something)? We should resolve this bug soon.
Yes, see comment #5.
Pascal, in the org.eclipse.osgi plugin, the package org.eclipse.runtime.adapter needs a package.html file. Can you provide this?
I would like to, however we need to be able to filter classes out of this package as only one class is API. Would you know how to do that?
Maybe Sonia will know, if this is even possible?
I've tried a variety of options (-excludes, only including .java file, etc) and to no avail.
I've found the combination of options that works to generate the javadoc for the one class, but I cannot suppress the creation of the entry for the package at the overview level. I've released the change to the HEAD and 3.1 maintenance streams and am testing.
We don't want to get rid of the package entry in the package overview. What you have in I20050921-2000 is good, however it is not the right class which is shown. It should be EclipseStarter instead of EclipseAdaptor
I've updated the options to do the right class in both streams.
I just checked the 3.1.1 RC2 (0923) build and the package description for org.eclipse.core.runtime.adaptor is still blank. I think because there is still no package.html in that package in the osgi plugin.
I will fix this right away. What approvals do I need to make this change to the RC build of 3.1.1?
Mike, is it ok if Thomas makes this change for the 3.1.1 RC3 build?
yes, it's fine.
package.html has been added. AFAIK that is the last thing needed to resolve this bug as FIXED.
Yes, I think you are right. Now we just need to verify it in tomorrow's RC3 build.