Bug 106304 - [doc] EclipseStarter javadoc missing
Summary: [doc] EclipseStarter javadoc missing
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Runtime (show other bugs)
Version: 3.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.1.1   Edit
Assignee: platform-runtime-inbox CLA Friend
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-08-07 10:02 EDT by Jeff McAffer CLA Friend
Modified: 2005-09-27 15:38 EDT (History)
4 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jeff McAffer CLA Friend 2005-08-07 10:02:13 EDT
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.
Comment 1 Pascal Rapicault CLA Friend 2005-08-08 08:50:45 EDT
Could you please verify what I missed here?
Comment 2 Sonia Dimitrov CLA Friend 2005-08-08 12:19:55 EDT
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.
Comment 3 Sonia Dimitrov CLA Friend 2005-08-08 13:13:54 EDT
Is a package.html required?  I don't see one in 
eclipseAdapter/src/org/eclipse/core/runtime/adatper.
Comment 4 Sonia Dimitrov CLA Friend 2005-08-08 13:25:19 EDT
Added entries in platformOptions and topic_Reference.xml.
Comment 5 Sonia Dimitrov CLA Friend 2005-08-09 09:45:05 EDT
Moving back to Platform Core to add package.html or close.
Comment 6 Sonia Dimitrov CLA Friend 2005-08-24 10:53:31 EDT
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.
Comment 7 Karice McIntyre CLA Friend 2005-08-29 17:36:32 EDT
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.
Comment 8 Sonia Dimitrov CLA Friend 2005-08-30 10:23:24 EDT
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). 
Comment 9 Karice McIntyre CLA Friend 2005-09-15 12:10:25 EDT
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.
Comment 10 Sonia Dimitrov CLA Friend 2005-09-15 12:49:53 EDT
Yes, see comment #5.
Comment 11 Karice McIntyre CLA Friend 2005-09-15 13:32:23 EDT
Pascal, in the org.eclipse.osgi plugin, the package org.eclipse.runtime.adapter 
needs a package.html file.  Can you provide this?
Comment 12 Pascal Rapicault CLA Friend 2005-09-15 15:02:17 EDT
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?
Comment 13 Karice McIntyre CLA Friend 2005-09-15 15:07:55 EDT
Maybe Sonia will know, if this is even possible?
Comment 14 Sonia Dimitrov CLA Friend 2005-09-15 16:06:15 EDT
I've tried a variety of options (-excludes, only including .java file, etc) 
and to no avail.
Comment 15 Sonia Dimitrov CLA Friend 2005-09-21 16:21:40 EDT
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.
Comment 16 Pascal Rapicault CLA Friend 2005-09-22 09:46:48 EDT
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
Comment 17 Sonia Dimitrov CLA Friend 2005-09-22 09:58:18 EDT
I've updated the options to do the right class in both streams.
Comment 18 Karice McIntyre CLA Friend 2005-09-27 13:25:53 EDT
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.
Comment 19 Thomas Watson CLA Friend 2005-09-27 13:39:53 EDT
I will fix this right away.  What approvals do I need to make this change to 
the RC build of 3.1.1?
Comment 20 Karice McIntyre CLA Friend 2005-09-27 14:05:18 EDT
Mike, is it ok if Thomas makes this change for the 3.1.1 RC3 build?
Comment 21 Mike Wilson CLA Friend 2005-09-27 14:52:21 EDT
yes, it's fine. 
Comment 22 Thomas Watson CLA Friend 2005-09-27 15:28:56 EDT
package.html has been added.  AFAIK that is the last thing needed to resolve 
this bug as FIXED.
Comment 23 Karice McIntyre CLA Friend 2005-09-27 15:38:48 EDT
Yes, I think you are right.  Now we just need to verify it in tomorrow's RC3 
build.