Bug 26785 - Document "how to make an API"
Document "how to make an API"
Status: RESOLVED FIXED
Product: platform
Classification: Unclassified
Component: -- Other --
3.x
PC Linux
: P2 (vote)
: 3.x
Assigned To: Jaroslav Tulach
issues@platform
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2002-08-26 16:31 UTC by Jaroslav Tulach
Modified: 2008-12-22 15:51 UTC (History)
6 users (show)

See Also:
Issue Type: TASK
:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jaroslav Tulach 2002-08-26 16:31:23 UTC
There is no clear documentation of how to create
API. Jesse suggested to adopt existing
versioning-specification.html, extract information
relevant for module writers and add additional
stuff at:

http://www.netbeans.org/servlets/ReadMsg?msgId=369970&listName=nbdev
Comment 1 Jaroslav Tulach 2002-10-31 12:08:07 UTC
The work has been started:
http://openide.netbeans.org/tutorial/api-design.html
Comment 2 pzajac 2002-12-11 14:00:23 UTC
I have a suggestion. There is no documentation for system properties
used in  openapi and core. I think that there should be created
document for these properties. A property can contain these information:
name
description
using - loging, hack, factory,... 
scope - openide, core, platform,  unix, widows, etc 
 
Comment 3 Jesse Glick 2002-12-11 17:00:39 UTC
Re. sys props - fine, but file separately, I don't think it has
anything to do with this issue at all.
Comment 4 Jesse Glick 2003-02-25 20:21:07 UTC
I am working on creating some infrastructure in nbbuild/javadoctools/
which should be useful generally for different modules (creating
Javadoc, creating change lists, etc.). All this stuff should be
documented alongside information on how to design and maintain the API
code itself.
Comment 5 Jaroslav Tulach 2003-05-12 20:32:02 UTC
There is a progress in
http://openide.netbeans.org/tutorial/api-design.html
that makes me belive consistent version will be done during 4.0
release time.
Comment 6 Jaroslav Tulach 2004-01-30 20:01:55 UTC
Another interesting reading available at
http://openide.netbeans.org/tutorial/api.html

More or less I think the task can be claimed done. However I am open
to suggestions how to improve the text.


By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2014, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo