168 |
\includegraphics[height=9cm]{short-trav-1.gen.eps}\hskip .4cm% |
\includegraphics[height=9cm]{short-trav-1.gen.eps}\hskip .4cm% |
169 |
\includegraphics[height=9cm]{short-trav-4.gen.eps}\hskip .4cm% |
\includegraphics[height=9cm]{short-trav-4.gen.eps}\hskip .4cm% |
170 |
\end{centering} |
\end{centering} |
171 |
\caption{ |
\caption{Three HTML pages modified by Navidoc. |
172 |
The left-most diagram in the javadoc page of Interface class Span (left-hand screenshot) |
The left and center pages are Javadoc pages into which the UML |
173 |
shows that |
diagrams have been automatically added by Navidoc at half size. |
174 |
Interface Span is related with Interface Scrollblock. The javadoc |
The right-hand page is a part of the design documentation for |
175 |
page of Interface class Scrollblock (middle screenshot) contains also the |
those interfaces. |
176 |
same diagram embedded. The description how the two |
The Javadoc pages are for classes which appear |
177 |
interfaces are used together is written in the architecture |
in the UML diagram on the design documentation page. |
178 |
page containing the description and full sized version of |
Reduced copies of this diagram have been added to both Javadoc pages. |
179 |
the same diagram (right-hand screenshot). |
The elements in the diagram are active: clicking on the Scrollblock |
180 |
|
element in any of the diagrams takes the user to the Scrollblock |
181 |
|
javadoc page. |
182 |
|
Traversing |
183 |
|
to the design document works by clicking the heading at the |
184 |
|
top of the diagram. |
185 |
|
In each version of the diagram, the element corresponding to |
186 |
|
the currently active node is highlighted both with color |
187 |
|
and a distinctive thick, irregular line to catch the viewer's eye. |
188 |
} |
} |
189 |
\end{figure*} |
\end{figure*} |
190 |
|
|
332 |
embedded within documentation page originals. In software |
embedded within documentation page originals. In software |
333 |
development groups, where programmers also write the documentation, |
development groups, where programmers also write the documentation, |
334 |
the switch from programming tools to documentation tools should |
the switch from programming tools to documentation tools should |
335 |
not be a |
not be a barrier to writing documentation and clarifying it with diagrams. |
336 |
barrier to writing documentation and clarifying it with diagrams. Textual |
However, with minor modifications, Navidoc should also be usable |
337 |
UML diagram description can naturally be written with any text |
when using direct manipulation GUIs to create the UML diagrams. |
338 |
editor. Compared to direct manipulation drawing tools, textual |
|
339 |
description may feel abstract, but describing things lexically is natural |
.. Compared to direct manipulation drawing tools, textual |
340 |
to programmers. |
description may feel abstract, but describing things lexically is natural |
341 |
|
to programmers. |
342 |
|
|
343 |
|
.. Textual |
344 |
|
UML diagram description can naturally be written with any text |
345 |
|
editor. |
346 |
|
|
347 |
.. Also at least for a |
.. Also at least for a |
348 |
programmer, who are used to describe objects lexically, describing |
programmer, who are used to describe objects lexically, describing |