This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 28309 - RFE: support the notion of an "unstable" API
Summary: RFE: support the notion of an "unstable" API
Status: RESOLVED INVALID
Alias: None
Product: java
Classification: Unclassified
Component: Unsupported (show other bugs)
Version: 3.x
Hardware: PC Windows ME/2000
: P3 blocker (vote)
Assignee: issues@java
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2002-10-28 16:41 UTC by eadams
Modified: 2007-09-26 09:14 UTC (History)
1 user (show)

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description eadams 2002-10-28 16:41:17 UTC
This RFE is summarized in 
http://openide.netbeans.org/servlets/ReadMsg?msgId=387201&listName=dev

JSR-175, A Metadata Facilty for the Java Programming Language, should also
be considered in the context of this RFE.

Repeated from the above post:

    I first saw the @unstable suggestion on nbdev,
    http://www.netbeans.org/servlets/ReadMsg?msgId=383587&listName=nbdev,
    from Alvin Thompson, bug # 4748349.  (Hmm, looks like
    the bug # must be wrong.)  Ok, quoting from Alvin's post:

       A DESCRIPTION OF THE PROBLEM :
       It would be nice to have an 'unstable' javadoc keyword,
       which would work similarly to the 'deprecated' keyword, to
       warn developers that the API of the documented item is still
       under development and subject to change. This should be
       trivial to implement since 'deprecated' already produces the
       desired functionality; all you would have change is the
       warning/error message the compiler spits out.

    I think this is clearly the right way to go, that is,
    developers mark the APIs as unstable/experimental/evolving,
    and tools warn users about it.

    Let me take the suggestion further and suggest that we
    take more of a leadership role here.  We could change the
    internal compiler to implement such functionality and support
    a new JavaDoc keyword.  We can also do as Tor has suggested
    here and provide a doclet to differeniate these APIs in 
    the JavaDoc, and we would probably want to change the code
    completion as well.  As Alvin pointed out. the code in the
    compiler should be easy as its just a subset of the current
    @deprecation support.

    Our tools would be adding value, there would be no incompatibility
    issues with people using different compilers, just a loss of
    advanced functionality, and it would serve a good existence
    proof for the JDK compiler team.
Comment 1 Jan Becicka 2005-10-12 14:54:45 UTC
We will not implement this. You can use @Annotations.
Comment 2 Torbjorn Norbye 2005-10-12 16:27:29 UTC
That wasn't the point of the bug. You could already use javadoc tags before for the part you can use 
annotations today.

The point of the request was that -we- predefine an annotation, AND, hook it up such that users get 
warnings when using it.

For example, in semantic syntax highlighting, where uses of deprecated method calls will use 
strikethrough, uses of unstable APIs could also be syntax highlighted specially in some way.

I think you should leave the feature request open.