[Gzz-commits] manuscripts ./gzigzag.bib UMLLink/SCRATCH UMLLi...

[Asko Soukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Asko Soukka <address@hidden>    03/01/27 09:19:38

Modified files:
        .              : gzigzag.bib 
        UMLLink        : SCRATCH umllink.rst 

Log message:
        Rational Soda

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/gzigzag.bib.diff?tr1=1.10&tr2=1.11&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/SCRATCH.diff?tr1=1.10&tr2=1.11&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/umllink.rst.diff?tr1=1.48&tr2=1.49&r1=text&r2=text

Patches:
Index: manuscripts/UMLLink/SCRATCH
diff -u manuscripts/UMLLink/SCRATCH:1.10 manuscripts/UMLLink/SCRATCH:1.11
--- manuscripts/UMLLink/SCRATCH:1.10    Mon Jan 27 05:38:17 2003
+++ manuscripts/UMLLink/SCRATCH Mon Jan 27 09:19:38 2003
@@ -1,4 +1,7 @@
-:Stamp: $Id: SCRATCH,v 1.10 2003/01/27 10:38:17 humppake Exp $
+:Stamp: $Id: SCRATCH,v 1.11 2003/01/27 14:19:38 humppake Exp $
+
+trashbin
+--------
 
    + and if design documentation is outdated some particular classes
      maybe don't even exist anymore!
@@ -20,8 +23,6 @@
 sources for references
 ----------------------
 
-Recommended sources for references: IEEE, ACM
-
 - This page lists a lot of UML tools;
   http://plg.uwaterloo.ca/~migod/uml.html
 
@@ -31,11 +32,6 @@
 - Labeled, typed links as cues when reading hypertext documents;
   http://search.epnet.com/direct.asp?an=9702214682&db=afh
 
-- Mapping UML to JAVA (generating Java code from UML);
-  http://doi.acm.org/10.1145/353171.353184
-
-- Automatically connecting documentation to code with rose;
-  http://doi.acm.org/10.1145/584955.584979 
   
 why uml
 -------
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.48 
manuscripts/UMLLink/umllink.rst:1.49
--- manuscripts/UMLLink/umllink.rst:1.48        Mon Jan 27 05:38:17 2003
+++ manuscripts/UMLLink/umllink.rst     Mon Jan 27 09:19:38 2003
@@ -2,7 +2,7 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
-:Stamp: $Id: umllink.rst,v 1.48 2003/01/27 10:38:17 humppake Exp $
+:Stamp: $Id: umllink.rst,v 1.49 2003/01/27 14:19:38 humppake Exp $
 
 Issues
 ======
@@ -43,6 +43,9 @@
       live within information flood)
     - blind users exists
 
+    - Rational Soda is WYSIWYG, maybe this could be discussed under
+      it
+
 - why even outdated but well simplified diagram
   is better than too detailed, automaticly up-to dated 
   and reverse engineered diagram.
@@ -56,11 +59,13 @@
     
 - how rational rose links diagrams into code and documentation?
 
-    STILL UNRESOLVED :( Probably all documentation is stored in
-    its datamodel and when generating sourcecode, the documentation
-    is embedded into source as comments. Documentation in the datamodel
-    could at least be browsed through hierarchical tree view, don't know
-    yet about cross-hierarchical links...
+    PARTIAL RESOLUTION: Probably all documentation is primary stored
+    within its own datamodel. The documentation within datamodel could
+    be browsed at least by Rose's hierachical tree menu. Implementation
+    of cross-hierarchical links and browsin along them still unkown.
+    When generating sourcecode, the documentation could be embedded into 
+    source as comments. Some user comment didn't like Rose's way of
+    adding extra comments into generated code 
<http://c2.com/cgi/wiki?RationalRose>
 
 Introduction
 ============
@@ -81,6 +86,9 @@
    from the code or the code from the documentation 
    (antont's note about duplication of data problem)
 
+   [harrison-barton-raghavachari00java-to-uml]
+   [pierce-tilley02connecting-documentation-rose]
+   
 In this article, we present the tools we developed
 for using UML diagrams as multiple-ended hyperlinks
 between the architectural documents and javadoc generated
@@ -151,11 +159,15 @@
 
 Rational Rose
 
+ - part of rational devtool suite
+
  - quite comprehensive UML design tool for different diagrams (class,
    sequence, state...) with direct manipulation interface
-
  - can reverse engingeer diagrams from existing source code
 
+ - co-operating with Rational Soda, Soda is WYSIWYG
+   [pierce-tilley02connecting-documentation-rose]
+
  - though, because we are coders, we would prefer UML script 
    language over menus and dialogs when creating UML objects 
 
@@ -202,19 +214,27 @@
        practical point of using the same writing tool foor coding and 
        documenting.
 
+   + Rose's problem with direct manipulation: a lot of windows, 
+     menus, dialogies etc... to get direct manipulateable graphic
+     representation for everything
+
    + though, directmanipulation is only relevant solution for
-     replacing already created objects
+     replacing already created object
+
+ - proprietary
 
 Dia (drawing, generating code templates)
 
- - more a drawing than design tool
+ - more a drawing than a design tool
  - could be used instead of metapost, but
    direct manipulation problem again
+ - open source 
 
 Doxygen
 
  - can generate useless diagrams from the code class hierarchy
  - should describe somewhere why these are useles... 
+ - uses non open source graphviz
 
 
 MetaPhor, hypertext in soft. devel? [metaphor]
@@ -230,6 +250,10 @@
    + meta CASE tool; could be made to generate code from the diagrams 
    + could be used to create domain spesific languages, when generating
      code can really work
+
+(We found no open source alternativa to our own development, which 
+combines all the good parts we need from previous tools without
+reformin dramatically our workin culture.)
 
 Javadoc
 -------
Index: manuscripts/gzigzag.bib
diff -u manuscripts/gzigzag.bib:1.10 manuscripts/gzigzag.bib:1.11
--- manuscripts/gzigzag.bib:1.10        Mon Jan 27 06:53:13 2003
+++ manuscripts/gzigzag.bib     Mon Jan 27 09:19:38 2003
@@ -2728,4 +2728,26 @@
     title = {Essays on Software Enginering.},
     year = {1975},
     publisher = {Reading, MA: Addison-Wesley},
+}
+
address@hidden,
+  author = {William Harrison , Charles Barton , Mukund Raghavachari},
+  title = {Mapping UML designs to Java},
+  booktitle = {ACM SIGPLAN Notices},
+  pages = {178-187},
+  year = {2000},
+  volume = {35},
+  number = {10},
+  month = {October},
+  doi = {http://doi.acm.org/10.1145/353171.353184}    
+}
+
address@hidden,
+  author = {Robert Pierce, Scott Tilley},
+  title = {Automatically connecting documentation to code with rose},
+  booktitle = {ACM SIGDOC Proceedings},
+  pages = {157-163},
+  year = {2002},
+  month = {October},
+  doi = {http://doi.acm.org/10.1145/584955.584979}    
 }