Bug 200726 - Create API javadoc for p2
Summary: Create API javadoc for p2
Status: RESOLVED FIXED
Alias: None
Product: Equinox
Classification: Eclipse Project
Component: p2 (show other bugs)
Version: 3.4   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.6 M6   Edit
Assignee: John Arthorne CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2007-08-21 16:28 EDT by Susan McCourt CLA
Modified: 2010-03-11 14:52 EST (History)
3 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Susan McCourt CLA 2007-08-21 16:28:29 EDT 
we should probably set a milestone for when we would expect javadoc to appear on the API classes.  I realize the problems with doing it too soon, but if we decide on a milestone we'll have a little lead time to deal with it.
Comment 1 Jeff McAffer CLA 2007-08-22 07:52:59 EDT 
Agreed.  M3?
Comment 2 Pascal Rapicault CLA 2007-08-22 08:35:33 EDT 
M4 because things may change significantly as we move toward more advanced scenarios.
Comment 3 John Arthorne CLA 2008-02-14 13:47:17 EST 
I've been filling in javadoc as I make changes in various places, but a comprehensive API cleanup won't happen until 3.5. We may also have some time very late in the 3.4 cycle since doc only changes are low risk.
Comment 4 Pascal Rapicault CLA 2008-12-12 21:17:16 EST 
API is no longer considered for 3.5.
Comment 5 Markus Keller CLA 2010-02-02 07:16:05 EST 
The file /org.eclipse.platform.doc.isv/aaa-how-to-add-things.txt contains a link to <http://wiki.eclipse.org/index.php/How_to_add_things_to_the_Eclipse_doc>, which explains how to add docs, especially:

"platformOptions.txt:
- code of required plug-ins must be added on the -classpath (the JAR(s)for non-JARed plug-ins and <plugin>/@dot for JARed plug-ins".

In M5, the classpath contained duplicates of plug-ins that have been added to the sourcepath, but did not contain all dependencies of the added plug-ins. I've fixed that for I20100202-0800.
Comment 6 John Arthorne CLA 2010-03-11 14:52:48 EST 
Marking fixed.