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 17775 - Document Module API usage
Summary: Document Module API usage
Status: RESOLVED WONTFIX
Alias: None
Product: platform
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 3.x
Hardware: PC Linux
: P3 blocker (vote)
Assignee: eadams
URL: http://openide.netbeans.org/versionin...
Keywords:
Depends on:
Blocks:
 
Reported: 2001-11-16 13:20 UTC by Jaroslav Tulach
Modified: 2008-12-22 21:06 UTC (History)
2 users (show)

See Also:
Issue Type: TASK
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jaroslav Tulach 2001-11-16 13:20:35 UTC
As a subtask of issue 17773 there is a need to document what API can be
considered offical and what one needs to take care when creating such API. 

A set of recommendations and steps to take to follow when one wants to create an
API should be the result of this efford.
Comment 1 Marek Grummich 2002-07-22 11:24:13 UTC
Set target milestone to TBD
Comment 2 Marek Grummich 2002-07-22 11:27:15 UTC
Set target milestone to TBD
Comment 3 Jaroslav Tulach 2003-02-04 15:33:51 UTC
I do not think there will be any progress on this. Or am I wrong?
Comment 4 eadams 2003-02-04 20:27:49 UTC
Sorry, I didn't realize that this issue was assigned to me.

The goal of issue 17773 and others is to provide a mechanism
for modules to have public APIs, that is, APIs with a committment
to backward compatibility.

I thought the intent was to use naming conventions to indicate a
module's public APIs.  This has been agreed upon, right?

So what else remains in this task?  It appears to be asking for
something much larger, like a general discussion of good API design.
If there are issues specific to the NetBeans APIs, that would be
useful, but a request for general API guidelines is better served
by books such as Effective Java.  Yes, I believe the NB APIs would
benefit if they had more closely followed the advice in Effective
Java (Jarda, no need to "kill your idol").

So, lets discuss what needs to be done here.