Re: [wtp-dev] Provisional API take II

[Arthur Ryman <ryman@xxxxxxxxxx>]

+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
intranet: http://labweb.torolab.ibm.com/DRY6/

Naci Dai <naci.dai@xxxxxxxxxxxxx>
Sent by: wtp-dev-bounces@xxxxxxxxxxx

05/18/2005 11:31 PM

Please respond to
naci.dai and "General discussion of project-wide or architectural issues."

To	"General discussion of project-wide or architectural issues." <wtp-dev@xxxxxxxxxxx>
cc
Subject	Re: [wtp-dev] Provisional API take II

How about addging a tag @provisional in addition to
the text.   We can 
ask jdt to flag them similar to deprecated when they are accessed.  This
will be very helpful


Timothy Deboer wrote:

>
> Hi,
>
> The PMC has decided to defer feature support until 1.1, but make some
> API provisional in 1.0 (without moving to internal.provisional b/c
of 
> the risk this late in the cycle) so that we do not block ourselves
> from doing it. The suggested documentation for this provisional API
> was JavaDoc, component.xmls, and release documentation.
>
> Elson has pointed out that it makes sense to standardize the javadoc
> and use a common task tag that we can all optionally enable. To start
> the discussion, how about using the following notice, which was used
> by the Eclipse debug team in v1.0:
>
>  * <b>Provisional API:</b> This class/interface is
part of an interim 
> API that is still under development and expected to
>  * change significantly before reaching stability. It is being
made 
> available at this early stage to solicit feedback
>  * from pioneering adopters on the understanding that any code
that 
> uses this API will almost certainly be broken
>  * (repeatedly) as the API evolves.
>
> The only change I've made is switching the word "Note" to
"Provisional 
> API" to make it a better task tag.
>
> Thanks,
> Tim deBoer
> WebSphere Tools - IBM Canada Ltd.
> (905) 413-3503  (tieline 969)
> deboer@xxxxxxxxxx
>
>------------------------------------------------------------------------
>
>_______________________________________________
>wtp-dev mailing list
>wtp-dev@xxxxxxxxxxx
>https://dev.eclipse.org/mailman/listinfo/wtp-dev
>  
>


-- 
Naci Dai,
eteration a.s. 
Inonu cad. Sumer sok. Zitas D1-15
Kozyatagi, Istanbul 34742
+90 (533) 580 2393 (cell)
+90 (216) 361 5434 (phone)
+90 (216) 361 2034 (fax)
http://www.eteration.com/
mailto:nacidai@xxxxxxx
mailto:naci@xxxxxxxxxxxxx

_______________________________________________
wtp-dev mailing list
wtp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/wtp-dev