[Gzz-commits] manuscripts ./gzigzag.bib UMLLink/short-paper.rst

[Tuomas J. Lukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Tuomas J. Lukka <address@hidden>        03/05/26 09:36:43

Modified files:
        .              : gzigzag.bib 
        UMLLink        : short-paper.rst 

Log message:
        Shorten refs

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/gzigzag.bib.diff?tr1=1.117&tr2=1.118&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/short-paper.rst.diff?tr1=1.36&tr2=1.37&r1=text&r2=text

Patches:
Index: manuscripts/UMLLink/short-paper.rst
diff -u manuscripts/UMLLink/short-paper.rst:1.36 
manuscripts/UMLLink/short-paper.rst:1.37
--- manuscripts/UMLLink/short-paper.rst:1.36    Mon May 26 09:23:51 2003
+++ manuscripts/UMLLink/short-paper.rst Mon May 26 09:36:43 2003
@@ -376,7 +376,7 @@
 to another so we have no data on that --- we expect the number
 would be even higher.
 
-Anecdotally XXX
+.. Anecdotally XXX
 
 .. , how much usage of UML diagrams
    as spatial menus replace usage of documentation's internal navigation.
@@ -398,21 +398,21 @@
 We have presented a navigational aid, which hypertexturally connects
 two distinct areas of documentation, using human-authored UML diagrams
 as spatial menus.
-
 It is not a new idea to use UML diagrams in documentation
-navigation. There already exists Javadoc like documentation generation
-tools, which generate automaticly class diagrams from program source
-code to help navigation inside the generated documentation.
-[heesch03doxygen]_, for example, generates diagrams of class
-inheritance tree for that purpose.
-
-Our approach is different, since we prefer fully human created
-diagrams in our design documentation. We want to avoid being bloated
-by a large amount of too detailed diagrams, which are often resulted
-by generators interpreting only the source code. On the other hand,
-recently there has been promising work based on textual analysis of
-connectable documentations [maletic03recovering]_. XXX need for the
-last sentence :).
+navigation. For example, Doxygen [heesch03doxygen]_ automatically
+generates class
+inheritance tree for navigation inside the embedded documentation.
+There has also been work on connecting the design documentation and
+program code through textual analysis [maletic03recovering]_.
+However, automatically generated diagrams and indices often include
+too much irrelevant information; human-made UML diagrams are quite different
+from automatically generated ones since they try to *express* a part of
+the system's semantics.
+
+What is new in our approach is the use of UML diagrams from the design
+documentation and their insertion to the relevant Javadoc / other embedded
+documentation pages as spatial menus allowing traversal between the design
+documentation and the Javadoc pages.
 
 .. Of course, generated documentation may give well detailed information
    from the current implementation, but the design documentation should
Index: manuscripts/gzigzag.bib
diff -u manuscripts/gzigzag.bib:1.117 manuscripts/gzigzag.bib:1.118
--- manuscripts/gzigzag.bib:1.117       Mon May 26 09:29:45 2003
+++ manuscripts/gzigzag.bib     Mon May 26 09:36:43 2003
@@ -3388,15 +3388,16 @@
 @inproceedings{devanbu99chime,
     author = "Premkumar T. Devanbu and Yih-Farn Chen and Emden R. Gansner and 
H. Muller and J. Martin",
     title = "{CHIME}: Customizable Hyperlink Insertion and Maintenance Engine 
for Software Engineering Environments",
-    booktitle = "International Conference on Software Engineering",
+    booktitle = "ICSE",
     pages = "473-482",
     year = "1999"
 }
address@hidden    booktitle = "International Conference on Software 
Engineering",
 
 @inproceedings{maletic03recovering,
     author = "Andrian Marcus and Jonathan I. Maletic",
     title = "Recovering Documentation-to-Source-Code Traceability Links using 
Latent Semantic Indexing",
-    booktitle = "International Conference on Software Engineering",
+    booktitle = "ICSE",
     pages = "125--137",
     year = "2003"
 }