[Gzz-commits] manuscripts/UMLLink SCRATCH umllink.rst

[Tuomas J. Lukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Tuomas J. Lukka <address@hidden>        03/01/21 04:32:39

Modified files:
        UMLLink        : SCRATCH umllink.rst 

Log message:
        reorg

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/SCRATCH.diff?tr1=1.3&tr2=1.4&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/umllink.rst.diff?tr1=1.19&tr2=1.20&r1=text&r2=text

Patches:
Index: manuscripts/UMLLink/SCRATCH
diff -u manuscripts/UMLLink/SCRATCH:1.3 manuscripts/UMLLink/SCRATCH:1.4
--- manuscripts/UMLLink/SCRATCH:1.3     Tue Jan 21 04:20:06 2003
+++ manuscripts/UMLLink/SCRATCH Tue Jan 21 04:32:38 2003
@@ -1,10 +1,11 @@
 
+This page lists a lot of UML tools:
+http://plg.uwaterloo.ca/~migod/uml.html
+
 Recommended sources for references: IEEE, ACM
 
 - Labeled, typed links as cues when reading hypertext documents; 
http://search.epnet.com/direct.asp?an=9702214682&db=afh
 
-- Automatically connecting documentation to code with rose; 
http://doi.acm.org/10.1145/584955.584979
-  reverse engineering diagrams from existing source code 
 - Mapping UML to JAVA; http://doi.acm.org/10.1145/353171.353184
   generating Java code from UML
 
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.19 
manuscripts/UMLLink/umllink.rst:1.20
--- manuscripts/UMLLink/umllink.rst:1.19        Tue Jan 21 04:26:41 2003
+++ manuscripts/UMLLink/umllink.rst     Tue Jan 21 04:32:38 2003
@@ -2,7 +2,7 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
-:Last-Modified: $Date: 2003/01/21 09:26:41 $
+:Last-Modified: $Date: 2003/01/21 09:32:38 $
 
 Introduction
 ============
@@ -25,7 +25,8 @@
 Previous work
 =============
 
-
+UML
+---
 
 Rational Rose
 
@@ -37,7 +38,7 @@
   reverse engineering diagrams from existing source code 
  - though, because we are coders, we would prefer UML language
    over menus and dialogs when creating UML objects 
-   + we need critic for direct manipulation! 
+   + we need a ref. of criticism of direct manipulation! 
    + though, directmanipulation is only relevant solution for
      replacing already created objects
 
@@ -64,32 +65,45 @@
    + could be used to create domain spesific languages, when generating
      code can really work
 
-This page lists a lot of UML tools:
-http://plg.uwaterloo.ca/~migod/uml.html
-
-Setting of problem
-==================
+Javadoc
+-------
 
 Javadoc, the hypertext documentation tool that comes with
 Java (trademark of Sun Microsystems, Javadoc is distributed only
 as part of Java, non-free), is ...
 
+Setting of problem
+==================
+
+javadoc
+
     - Easy to check methods, hard to get overall picture.
 
     - Because doc is generated from source, the class, method, field
       names are always up-to-date(!!)
 
-Architectural docs using UML: 
+    - easy to find a given class
+
+Architectural docs with UML diagrams: 
+
+    - good overall picture. 
 
     - little detail, 
 
     - may be slightly outdated at any particular time. 
 
-    - good overall picture. 
-
     - Even outdated but well simplified diagram
       is better than too detailed, automaticly up-to dated and reverse
       engineered diagram.
+
+    - distinct from the javadoc, hard to find explanations
+      for a particular class.
+
+The two types of documentation are complementary.
+
+"Obvious" question: can we increase the overall value by
+interconnecting the two?
+
 
 
 Design