[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/23 02:59:45

Modified files:
        UMLLink        : SCRATCH umllink.rst 

Log message:
        org

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/SCRATCH.diff?tr1=1.6&tr2=1.7&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/umllink.rst.diff?tr1=1.36&tr2=1.37&r1=text&r2=text

Patches:
Index: manuscripts/UMLLink/SCRATCH
diff -u manuscripts/UMLLink/SCRATCH:1.6 manuscripts/UMLLink/SCRATCH:1.7
--- manuscripts/UMLLink/SCRATCH:1.6     Wed Jan 22 10:32:41 2003
+++ manuscripts/UMLLink/SCRATCH Thu Jan 23 02:59:45 2003
@@ -1,5 +1,11 @@
-:Stamp: $Id: SCRATCH,v 1.6 2003/01/22 15:32:41 humppake Exp $
-:Last-Modified: $Date: 2003/01/22 15:32:41 $
+:Stamp: $Id: SCRATCH,v 1.7 2003/01/23 07:59:45 tjl Exp $
+:Last-Modified: $Date: 2003/01/23 07:59:45 $
+
+   + and if design documentation is outdated some particular classes
+     maybe don't even exist anymore!
+
+   + the javadoc output filestructure follows the
+     hierarchical tree structure of java packages and classes
 
 sources for references
 ----------------------
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.36 
manuscripts/UMLLink/umllink.rst:1.37
--- manuscripts/UMLLink/umllink.rst:1.36        Thu Jan 23 02:41:13 2003
+++ manuscripts/UMLLink/umllink.rst     Thu Jan 23 02:59:45 2003
@@ -2,8 +2,8 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
-:Stamp: $Id: umllink.rst,v 1.36 2003/01/23 07:41:13 tjl Exp $
-:Last-Modified: $Date: 2003/01/23 07:41:13 $
+:Stamp: $Id: umllink.rst,v 1.37 2003/01/23 07:59:45 tjl Exp $
+:Last-Modified: $Date: 2003/01/23 07:59:45 $
 
 Issues
 ======
@@ -108,6 +108,13 @@
 UML
 ---
 
+ - diagrams are from human to human
+
+   + we don't wan to generate diagrams from the code or generate
+     code from the diagrams
+   + generated diagrams are too detailed to be beneficial
+   + basic architectural diagrams should be done before code anyway
+
 Rational Rose
 
  - quite comprehensive UML design tool for different diagrams (class,
@@ -174,16 +181,6 @@
 and are written either before coding (for design) or after (for exposition
 of the architecture).
 
- - diagrams are from human to human
-
-   + we don't wan to generate diagrams from the code or generate
-     code from the diagrams
-   + generated diagrams are too detailed to be beneficial
-   + basic architectural diagrams should be done before code anyway
-
-   + and if design documentation is outdated some particular classes
-     maybe don't even exist anymore!
-
 
  - Include PEGs: possibly not-yet accepted or not-yet implemented proposals 
    for architectural changes.
@@ -193,11 +190,7 @@
  - fully generated documentation from javadoc comments
    of each class and method in the java source code
 
-   + the javadoc output filestructure follows the
-     hierarchical tree structure of java packages and classes
-
 
-      
 
 
 
@@ -243,7 +236,12 @@
 
 
 "Obvious" question: can we increase the overall value by
-interconnecting the two?
+interconnecting the two? 
+When looking at a design document, jumping to the javadocs
+to get the details would be useful, and
+when looking at a Javadoc, it would be useful
+to be able to see if any design documents refer to that class.
+This is the starting point for the toolchain developed in this article.
 
 Design
 ======