92 |
* easy to document: any rst can contain UML (what about explicitly in |
* easy to document: any rst can contain UML (what about explicitly in |
93 |
Javadoc?) |
Javadoc?) |
94 |
|
|
95 |
|
Conceptual model (for HT people!) |
96 |
|
================================= |
97 |
|
|
98 |
|
* Java class: node |
99 |
|
* Java package: hierarchical classification of nodes, also node |
100 |
|
|
101 |
|
* Documentation: the hypertext universe |
102 |
|
* the two distinct pieces of documentation: originally no cross-links |
103 |
|
* source code documentation as javadoc-format comments; translated to |
104 |
|
HTML pages by Sun's Javadoc tool |
105 |
|
* architectural documentation (and PEGs) which may contain UML diagrams |
106 |
|
as rst-format files; translated to architecture documents |
107 |
|
(documentation nodes?) |
108 |
|
|
109 |
|
* UML diagrams: distinct context for Java classes and packages and relevant |
110 |
|
architectural documentation; spatial menu; also node (XXX multi-ended nexus |
111 |
|
links) |
112 |
|
|
113 |
|
* Cross-reference by Javadoc: cheap cross-link |
114 |
|
* Cross-link from javadoc comments: simple hyperlink |
115 |
|
* Indexes by Javadoc: hierarchy navigation tool |
116 |
|
(poorly implemented as WWW) |
117 |
|
|
118 |
|
* Links in UML diagrams: context navigation links |
119 |
|
|
120 |
|
* (XXX Free Software vs. Open Source vs. Open Software vs. Open Project...) |
121 |
|
|
122 |
Introduction |
Introduction |
123 |
============ |
============ |