[Gzz-commits] manuscripts/UMLLink umllink.rst

[Tuomas J. Lukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Tuomas J. Lukka <address@hidden>        03/01/23 08:28:47

Modified files:
        UMLLink        : umllink.rst 

Log message:
        developersview

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/umllink.rst.diff?tr1=1.39&tr2=1.40&r1=text&r2=text

Patches:
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.39 
manuscripts/UMLLink/umllink.rst:1.40
--- manuscripts/UMLLink/umllink.rst:1.39        Thu Jan 23 08:12:08 2003
+++ manuscripts/UMLLink/umllink.rst     Thu Jan 23 08:28:47 2003
@@ -2,8 +2,8 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
-:Stamp: $Id: umllink.rst,v 1.39 2003/01/23 13:12:08 tjl Exp $
-:Last-Modified: $Date: 2003/01/23 13:12:08 $
+:Stamp: $Id: umllink.rst,v 1.40 2003/01/23 13:28:47 tjl Exp $
+:Last-Modified: $Date: 2003/01/23 13:28:47 $
 
 Issues
 ======
@@ -272,6 +272,8 @@
    - can be useful to link even concept with the class 
      that eventually implemented it.
 
+ - Packages to either Java packages, or the package design document
+
 Documentation's reader's point of view
 ---------------------------------------
 
@@ -332,7 +334,7 @@
     we can reduce the size of the diagram in the javadoc by 50%.
    
     + technical note: hovering mouse over diagram will show 
-      class names even on diminished diagrams
+      link target class names even on diminished diagrams
 
 Advantage over paper: MAJOR: multi-end links easily traversable,
 structure can be understood
@@ -340,25 +342,27 @@
 Documentation's developer's point of view
 -----------------------------------------
 
- + HTML/WWW browsers don't support bi-directional links
-
-Goals:
-
- - small, incremental changes to existing javadoc / other documentation
-
- - Low threshold for writing new documentation, diagrams etc.
+As little hassle as possible.
 
  - minimun barrier to drawing a even small diagram to make
    document more clear, and to new documents
 
- - "feeling" that the arch. doc will be read(!)
+After Step 1 from user's perspective, the computer has *all* the information
+needed for steps 2 and 3, so *no further changes should be required*.
+
+For Step 1, it is best to demand explicit links in the UML diagrams.
 
- - link diagrams' objects to code documentation, which 
-   they represent
+Steps 2,3:
 
  - implicitly embed diagrams into relevant code documentation, and
    backlink code documentation to design documentation
 
+Javadoc comments should not need to be changed at all.
+
+Goals:
+
+ - "feeling" that the arch. doc will be read(!)
+
  - if diagrams try to link objects, which don't exist (e.g. removed
    Java class), the linking objects will be specially marked 
    e.g. colored red, or an error when compiling will be given
@@ -428,6 +432,8 @@
 
 Implementation
 ==============
+
+ + HTML/WWW browsers don't support bi-directional links
 
 Goals: