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 30370

Summary:	Arch description of openide & core
Product:	platform	Reporter:	Jaroslav Tulach <jtulach>
Component:	Documentation	Assignee:	Jaroslav Tulach <jtulach>
Status:	RESOLVED FIXED
Severity:	blocker	CC:	jglick
Priority:	P1	Keywords:	ARCH, UMBRELLA
Version:	3.x
Hardware:	All
OS:	All
Issue Type:	TASK	Exception Reporter:
Bug Depends on:	30372, 30373, 30374, 30375, 30376, 30377, 30378, 30379, 30380, 30381, 30382, 30384, 30386, 30387, 30388, 30389, 30558, 31058, 31065, 31072, 31177, 31344, 31461, 31610, 31611, 32083, 32762, 34204
Bug Blocks:	19781

Description Jaroslav Tulach 2003-01-27 15:54:08 UTC

Describe the architecture of openide & core by
answering set of NetBeans Architecture Questions
as described at 

http://openide.netbeans.org/tutorial/api.html

Comment 1 Jesse Glick 2003-02-03 20:09:12 UTC

BTW are these questions supposed to be answered per (1) literal module
= JAR or (2) per functional category? E.g.

- "Modules API" refers to some classes in openide.jar and some in core.jar

- "Compiler API" is just openide-compiler.jar, but core-compiler.jar
is normally used with it

The breakdown seems unclear to me. Existing subissues all seem to be
in openide, not core.

Comment 2 Jaroslav Tulach 2003-02-04 13:25:27 UTC

Seems we should document both openide/core part, just describe what is
in openide what in impl. Window system does it (a bit), lookup will be
updated to this model.

Comment 3 Jesse Glick 2003-02-04 16:59:26 UTC

So arch-openide-io.xml should describe contents of core/output too?
What about core/term etc.?

Comment 4 Jaroslav Tulach 2003-02-04 17:40:34 UTC

I guess it should describe both. Or it is possible to create separate
documents for each of these parts. That is up to you.

Comment 5 Jesse Glick 2003-02-04 17:55:15 UTC

If I use separate documents, where are they supposed to go? Is there
some sort of file layout convention already? I ask because there is
already an incomplete correspondence between NB module and answer
document, and even where there is a subdir in sources for a module
(e.g. openide/compiler/) the answers are still in the top-level
openide/arch/ dir.

Comment 6 Jaroslav Tulach 2003-03-03 08:37:33 UTC

Layout: Should be probably close to the module API. If it is included
in the API. But I hae no clear ideas about that.

Comment 7 Jaroslav Tulach 2004-07-26 09:18:10 UTC

Documenations provided.