107 |
* UML diagrams: distinct context for Java classes and packages and relevant |
* UML diagrams: distinct context for Java classes and packages and relevant |
108 |
architectural documentation; spatial menu; also node (XXX multi-ended nexus |
architectural documentation; spatial menu; also node (XXX multi-ended nexus |
109 |
links) |
links) |
110 |
* generated by our UML tool from our UML diagram description language |
* generated by our UML tool from our UML diagram description language |
111 |
|
|
112 |
* Cross-reference by Javadoc: cheap cross-link |
* Cross-reference by Javadoc: cheap cross-link |
113 |
* Cross-link from javadoc comments: simple hyperlink |
* Cross-link from javadoc comments: simple hyperlink |
128 |
on more general level, while the program code source files give all the minute |
on more general level, while the program code source files give all the minute |
129 |
details on how the computer should act and contain embedded documentation for |
details on how the computer should act and contain embedded documentation for |
130 |
human-readability. Although these two parts of documentation are |
human-readability. Although these two parts of documentation are |
131 |
semantically dependent, in praftice they are often linked scarcely -- if at |
semantically dependent, in practice they are often linked scarcely -- if at |
132 |
all. |
all. |
133 |
|
|
134 |
The Unified Modeling Language (UML) is the standard way to visually describe |
The Unified Modeling Language (UML) is the standard way to visually describe |
161 |
.. [#] booch-jacobson-rumbaugh-uml-user-guide, p.24 |
.. [#] booch-jacobson-rumbaugh-uml-user-guide, p.24 |
162 |
|
|
163 |
|
|
164 |
In this article, we present a navigational tool which connects the two distinct |
In this article, we present a navigational aid which connects the two distinct |
165 |
areas of documentation, and the fairly simple tool implementation which |
areas of documentation, and its fairly easy implementation which |
166 |
supplements the toolchain of other Free Software [] we use. The other |
supplements the toolchain of other Free Software [] we use. The other |
167 |
documentation tools can already generate web pages, and the tool injects the |
documentation tools can already generate web pages, and the tool injects the |
168 |
added linking to those HTML files. The tool automatically generates the |
added linking to those HTML files. The tool automatically generates the |
353 |
|
|
354 |
- Dia could be used instead of metapost, but |
- Dia could be used instead of metapost, but |
355 |
direct manipulation problem again |
direct manipulation problem again |
356 |
|
|
357 |
|
|
358 |
|
.. bibliography:: gzigzag |