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 52275 - Editor APIs Documentation Review
Summary: Editor APIs Documentation Review
Status: RESOLVED WONTFIX
Alias: None
Product: editor
Classification: Unclassified
Component: -- Other -- (show other bugs)
Version: 4.x
Hardware: All All
: P2 blocker (vote)
Assignee: issues@editor
URL:
Keywords: API_REVIEW
Depends on:
Blocks:
 
Reported: 2004-12-09 21:19 UTC by Miloslav Metelka
Modified: 2007-12-11 08:42 UTC (History)
4 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments
Generated arch-editor.html (64.13 KB, text/html)
2004-12-09 21:26 UTC, Miloslav Metelka
Details
New version of arch-editor.html (fixing the mentioned things) (68.69 KB, text/html)
2004-12-13 16:20 UTC, Miloslav Metelka
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Miloslav Metelka 2004-12-09 21:19:01 UTC
This is a request for review of current editor
APIs such as editor's popup menu action xml layer
registrations, annotation types registrations,
tooltip annotations, keybindings, abbreviations
and macros.
Comment 1 Miloslav Metelka 2004-12-09 21:25:25 UTC
I have updated the previously mentioned plus the document properties
and the system properties used by the editor. I have updated and
checked into trunk the arch-editor.xml. I'm attaching the current
generated arch-editor.html.
Comment 2 Miloslav Metelka 2004-12-09 21:26:19 UTC
Created attachment 19241 [details]
Generated arch-editor.html
Comment 3 Miloslav Metelka 2004-12-09 21:28:40 UTC
I'm reassigning to Tomas Pavek who is going to be review owner.
Comment 4 Miloslav Metelka 2004-12-10 12:57:17 UTC
I'm working on further updates - removal of some obsolete things
(parser dbs, old jre), public packages description etc.
I'll attach updated arch version then.
Comment 5 Miloslav Metelka 2004-12-13 16:20:37 UTC
Created attachment 19260 [details]
New version of arch-editor.html (fixing the mentioned things)
Comment 6 Jaroslav Tulach 2004-12-14 16:06:16 UTC
Initial review is going to be tomorrow. Reviewers include me (nobody
else is interested), Jesse (as we are likely to discuss the editor
separation as well) and Petr Pisl (as he needs certain editor features
in web support).
Comment 7 Miloslav Metelka 2004-12-14 22:29:55 UTC
OK, I have left the issue 51486 (editor module split) closed (to be
discussed as part of this review) but I have answered Jesse's and
Yarda's question in the issue. I have updated the split document
http://editor.netbeans.org/doc/Proposals/ModuleSplit/DesignView.html
Comment 8 Jaroslav Tulach 2004-12-15 10:57:49 UTC
My comments to the "documentation project":

Y01 arch-usecases is empty. It should not be, if this is about
documentation, this is going to be the main starting point. So I guess
usecase tags like: how do I add an action to editor popup menu? How do
I do add it to toolbar? How can I assign a shortcut? How to write and
register my own editor kit? Should be there. I know some of this is
answered later in the document, but this will make it easier to find.

Y02 deploy-packages: maybe use one <api> tag for each package and
replace one general EditorModuleAPI? But I guess this may change due
to the split of the module (which I have not read yet).

Y03 resources-layer: Use <api group="layer" /> to describe things that
you offer for registration - "instead of AnnotationTypes can be
registered" describe this in api tag and provide a sample. This may
form nice usecase as well. Btw. it is possible to use the api tag with
the same name more times in one document (they should have consistent
attributes), the content of the element gets merged.

Y04 lookup-lookup: Replace WindowManager ErrorManager and
DataLoaderPool by calling getDefault(), sometimes finding this in
lookup is equivalent, sometimes it is even buggy!

Y05 exec-reflection: Do I understand right that you are using
reflection where package private field would do? Fix it, please.

Y06 format-types: Again describe as api or usecase. To make it easier
to find and more useful (if not described somewhere else).
Comment 9 Petr Pisl 2004-12-15 15:44:14 UTC
I  don't understand what you mean, that the packages
org.netbeans.editor.ext.html / java will independent of the NetBeans
IDE. Do you do such changes in these packages to it be true this?
Comment 10 Tomas Pavek 2004-12-20 13:53:49 UTC
Opinion document available at
http://www.netbeans.org/issues/show_bug.cgi?id=52275
Comment 11 Jaroslav Tulach 2007-12-11 08:21:40 UTC
Looks like forgotten API review request. Please handle it somehow (won'tfix?).
Comment 12 Miloslav Metelka 2007-12-11 08:42:56 UTC
OK, closing as wontfix. We likely won't be fixing the editor module's arc doc. Instead we try to provide the appropriate
docs for the newly created editor APIs through javadocs and arch docs.