Re: [cross-project-issues-dev] Development/APIs Requirement question

[David M Williams <david_williams@xxxxxxxxxx>]

> how should I document them

The best way is to open bugs against the component where you found you need to use internal non-API, describing what you use, and why. This has the benefit of letting them know what you are using, making it a little less likely they would break you in the future, perhaps provide an API in the future, or, perhaps, tell you some way to accomplish the same thing using API.

Then, once you open the bugs against the components where you use non-API, just list the bugs in your "Galileo API bug". Then your done. Anyone can then go and read through the bugs to find out the extent of non-API use.

Thanks,


"Igor V. Burilo" ---03/06/2009 11:40:47 AM---Hello,

From:	"Igor V. Burilo" <igor.burilo@xxxxxxxxxxxx>
To:	<cross-project-issues-dev@xxxxxxxxxxx>
Date:	03/06/2009 11:40 AM
Subject:	[cross-project-issues-dev] Development/APIs Requirement question
Sent by:	cross-project-issues-dev-bounces@xxxxxxxxxxx

---

Hello,
 
I verified Subversive with PDE API Tools on leveraging only published APIs of dependencies and got the API usage problems related to non-API usage (e.g. implements non-API interface, non-API parameter type etc.) and illegal usage (e.g. illegally extends, illegally implements etc.).
 
In general most problems of incorrect API usage are related to using eclipse team API (e.g. org.eclipse.team.internal.ui.synchronize.IChangeSetProvider, org.eclipse.team.internal.ui.actions.TeamAction).
 
Development/APIs requirement says the following "all deviations must be documented". As I can't find another way how to avoid using non-API or restricted classes/interfaces, how should I document them(or process in another way)?

Best regards,
Burilo Igor

_______________________________________________
cross-project-issues-dev mailing list
cross-project-issues-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev