Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [wtp-dev] [action required] API Definition Plan

Thanks Jeffrey, I've cleaned up the xml and _javascript_ related ones.

Can I make a request too?
1. Besides percents, can you please report total "API's" as well ... I just think that would be interesting, and important to compare to other platforms, such as base Eclipse.

2. I think just as important as having our own API's well defined, is having no violations of APIs provided by base Eclipse (or other pre-reqs) ... will that be part of your reports too? I didn't see that in build page reports. And, if its part of the API violation reports, which mostly report our own many internal violations, which we've already said we'd live with for Version 1, is there a way the reports can be generated to call those "pre-req violations" out separately?

Thanks again,


Jeffrey Liu <jeffliu@xxxxxxxxxx>
Sent by: wtp-dev-admin@xxxxxxxxxxx

03/20/2005 02:15 PM

Please respond to

Re: [wtp-dev] [action required] API Definition Plan

We have great progress on the API front. Preliminary results (preliminary means local build on my machine and eyeball-ing the result) show that we have a 40% reduction in untested APIs and a 60% reduction in incomplete javadocs (comparing to results from last week). Thanks for everyone's hard working in refining their component.xml files. It's now up to us to chip away at the untested/incomplete javadoc-ed APIs. Btw, these results will be available in the next build.

Couples of issues that showed up.....

1. There are a few plugins that do not belong to any component.xml files. Would owners of the following plugins add them to a component?

2. There are a couple of plugins declared in a component.xml file, but they do not exist (at least in the build process). They do not affect the results, but it would be nice to clean it up.
org.eclipse.wst._javascript_.common.ui (declared in wst\org.eclipse.wst._javascript_.core\component.xml)
org.eclipse.wst.rdb.sqleditor (declared in wst\org.eclipse.wst.rdb.core\component.xml)

Let me know if you have any questions or concerns.


Jeffrey Liu
IBM Rational Software - Performance Analyst
IBM Toronto Lab.
8200 Warden Ave. Markham, Ontario, L6G 1C7
Internal mail: D3/R8V/8200/MKM (D3-268)
T/L: 969 3531
Tel: (905) 413 3531
Fax: (905) 413 4920

Arthur Ryman/Toronto/IBM@IBMCA
Sent by: wtp-dev-admin@xxxxxxxxxxx

03/16/2005 10:07 AM

Please respond to

[wtp-dev] [action required] API Definition Plan

The theme of M4 is "API Definition". Our goal at the end of M4 is to have our APIs defined and ready for public review and feedback. We need to start tracking our progress towards meeting the M4 API exit criteria. Here's a proposal for how the PMC would like to handle this.

We'll do the following each week until M4 is released.

1. Component leads should update their component.xml descriptors by EOD Friday.

2. Jeffrey Liu will generate and publish a progress report Monday .

3. The PMC will review the progress report  at the telecon on Tuesday and discuss corrective actions as required.

To get the ball rolling, the component.xml descriptors must be repatriated to their components. At present Jeffrey is generating these based on the naming convention. All component leads should now grab the latest version of their component.xml and put it in one plug-in that belongs to the component. Recall that a component is a collection of plug-ins and fragments. Pick one plug-in in each component as the "main" plug-in and put the component.xml there in the same folder as plugin.xml.

Every plug-in and fragment must belong to exactly one component.

It is more important now to have an accurate list of the proposed API classes than it is to have all non-API packages renamed to internal. Therefore, update component.xml to exclude any classes that are not going to be API. You can do the renaming later. If you don't understand how to write component.xml files, Jeffrey can assist you.

Jeffrey will update the report generation to be driven from the "real" component.xml that the component leads create. The report will provide the following kind of information so everyone can assess their progress and the amount of work remaining:

For each component and each API class:

1. total number of API methods

2. total number of API methods that have complete Javadoc

3. total number of API methods that have JUnit coverage

4. does a component API overview document exist?
5. a component API completion score which is a weighted average of 2, 3, and 4

If an API is not converging towards the exit criteria we will have to determine if we can redirect resources to it, or failing that, defer it to WTP 1.1.

Arthur Ryman,
Rational Desktop Tools Development

phone: +1-905-413-3077, TL 969-3077
assistant: +1-905-413-2411, TL 969-2411
fax: +1-905-413-4920, TL 969-4920
mobile: +1-416-939-5063, text: 4169395063@xxxxxxx

Back to the top