[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gzz-commits] manuscripts/UMLLink article.rst
From: |
Asko Soukka |
Subject: |
[Gzz-commits] manuscripts/UMLLink article.rst |
Date: |
Sat, 15 Feb 2003 18:48:14 -0500 |
CVSROOT: /cvsroot/gzz
Module name: manuscripts
Changes by: Asko Soukka <address@hidden> 03/02/15 18:48:13
Modified files:
UMLLink : article.rst
Log message:
a couple of internal links
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/article.rst.diff?tr1=1.107&tr2=1.108&r1=text&r2=text
Patches:
Index: manuscripts/UMLLink/article.rst
diff -u manuscripts/UMLLink/article.rst:1.107
manuscripts/UMLLink/article.rst:1.108
--- manuscripts/UMLLink/article.rst:1.107 Sat Feb 15 18:44:58 2003
+++ manuscripts/UMLLink/article.rst Sat Feb 15 18:48:13 2003
@@ -9,7 +9,7 @@
.. Alternative title: "Free Software toolchain for bidirectional
linking between UML diagrams and Javadoc"
-.. :Stamp: $Id: article.rst,v 1.107 2003/02/15 23:44:58 tuukkah Exp $
+.. :Stamp: $Id: article.rst,v 1.108 2003/02/15 23:48:13 humppake Exp $
.. Points for HT people
====================
@@ -560,15 +560,13 @@
.. Advantage over paper: SOME: see the UML diagram contexts of a class,
traverse them
-**Step 3; From Javadoc through a UML diagram to a design document.**
-Even though the design documents were not included
-in the original UML diagrams, they are included in the final
-image on top of the diagram. Including **all** the contexts where
-the diagram appears as links
-in the graphical
-image creates a consistent whole - a spatial focus+context menu.
-The element that represents the current hypertext node
-is emphasized (colored and also circled) for clarity.
+**Step 3; From Javadoc through a UML diagram to a design document.**
+Even though the design documents were not included in the original UML
+diagrams, they are included in the final image on top of the diagram
+[ref-screenshot]_. Including **all** the contexts where the diagram
+appears as links in the graphical image creates a consistent whole - a
+spatial focus+context menu. The element that represents the current
+hypertext node is emphasized (colored and also circled) for clarity.
Because the original location on the diagrams is easily reachable from
its every implicit occurerrence in Javadoc or in design documentation,
@@ -590,11 +588,11 @@
For Step 1, we keep it best to demand explicit links in the UML
diagrams. Author has to decide for each object in UML diagram whether
it should be linked, for example, by giving a fully-qualified java
-class name or a relative path to design documentation page. After Step
-1 from author's perspective, the computer has *all* the information
-needed to complete also steps 2 and 3, so *no further changes should
-be required*. For example javadoc comments should not need changes at
-all.
+class name or a relative path to design documentation page
+[ref-umltoolumlsourcelinked]_. After Step 1 from author's perspective,
+the computer has *all* the information needed to complete also steps 2
+and 3, so *no further changes should be required*. For example javadoc
+comments should not need changes at all.
During steps 2 and 3 computer simply embeds diagrams into previously linked
documentation pages and creates backlinks to the initiating documentation
- [Gzz-commits] manuscripts/UMLLink article.rst, (continued)
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuukka Hastrup, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuomas J. Lukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuukka Hastrup, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuukka Hastrup, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Asko Soukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuukka Hastrup, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Asko Soukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Asko Soukka, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuukka Hastrup, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst,
Asko Soukka <=
- [Gzz-commits] manuscripts/UMLLink article.rst, Benja Fallenstein, 2003/02/15
- [Gzz-commits] manuscripts/UMLLink article.rst, Tuukka Hastrup, 2003/02/15