[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gzz-commits] manuscripts/UMLLink article.rst umldoc-flow.dia...
|
From: |
Asko Soukka |
|
Subject: |
[Gzz-commits] manuscripts/UMLLink article.rst umldoc-flow.dia... |
|
Date: |
Sat, 15 Feb 2003 05:24:56 -0500 |
CVSROOT: /cvsroot/gzz
Module name: manuscripts
Changes by: Asko Soukka <address@hidden> 03/02/15 05:24:56
Modified files:
UMLLink : article.rst umldoc-flow.dia
umltool-example-uml-linked.dia
Log message:
tableupdate
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/article.rst.diff?tr1=1.44&tr2=1.45&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/umldoc-flow.dia.diff?tr1=1.5&tr2=1.6&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/umltool-example-uml-linked.dia.diff?tr1=1.5&tr2=1.6&r1=text&r2=text
Patches:
Index: manuscripts/UMLLink/article.rst
diff -u manuscripts/UMLLink/article.rst:1.44
manuscripts/UMLLink/article.rst:1.45
--- manuscripts/UMLLink/article.rst:1.44 Sat Feb 15 05:13:23 2003
+++ manuscripts/UMLLink/article.rst Sat Feb 15 05:24:55 2003
@@ -9,7 +9,7 @@
.. Alternative title: "Free Software toolchain for bidirectional
linking between UML diagrams and Javadoc"
-.. :Stamp: $Id: article.rst,v 1.44 2003/02/15 10:13:23 benja Exp $
+.. :Stamp: $Id: article.rst,v 1.45 2003/02/15 10:24:55 humppake Exp $
.. Points for HT people
====================
@@ -325,27 +325,33 @@
The two types of documentation are complementary, as demonstrated
in the following table:
-+---------------------------------+-----------------------------------+
-| Design documentation | Javadoc |
-+=================================+===================================+
-| good overall picture. | easy to find a given class, |
-| | easy to check all methods |
-+---------------------------------+-----------------------------------+
-| little detail, | detailed |
-+---------------------------------+-----------------------------------+
-| may be slightly outdated at | methods and classes *always* |
-| any particular time. | up to date (generated from |
-| | source), doc comments also |
-| | usually |
-+---------------------------------+-----------------------------------+
-| hard to find explanations | no overall picture of classes' |
-| for a particular class. | roles |
-+---------------------------------+-----------------------------------+
-| UML diagrams | --- |
-+---------------------------------+-----------------------------------+
-| written and organized by | written by humans, organized |
-| humans | rigidly by package structure |
-+---------------------------------+-----------------------------------+
+.. figure:: table
+ :environment: table
+ :label: documentations
+
+ Comparing design documentation to Javadoc.
+
+ +------------------------------+----------------------------------+
+ | Design documentation | Javadoc |
+ +==============================+==================================+
+ | good overall picture. | easy to find a given class, |
+ | | easy to check all methods |
+ +------------------------------+----------------------------------+
+ | little detail, | detailed |
+ +------------------------------+----------------------------------+
+ | may be slightly outdated at | methods and classes *always* |
+ | any particular time. | up to date (generated from |
+ | | source), doc comments also |
+ | | usually |
+ +------------------------------+----------------------------------+
+ | hard to find explanations | no overall picture of classes' |
+ | for a particular class. | roles |
+ +------------------------------+----------------------------------+
+ | UML diagrams | --- |
+ +------------------------------+----------------------------------+
+ | written and organized by | written by humans, organized |
+ | humans | rigidly by package structure |
+ +------------------------------+----------------------------------+
Because Javadoc is fully generated, it is always up to date. Our
design documentation, though, is updated manually. Of course, it
@@ -433,26 +439,32 @@
diagrams. Different diagram types can be linked within the
design documentation and to javadoc as follows:
-+-----------------------+-----------------------+--------------------+
-| Conceptual | Specification | Implementation |
-+=======================+=======================+====================+
-| probably no links | can link Java | can link all |
-| to javadoc | interfaces and | classes |
-| | some classes | |
-+-----------------------+-----------------------+--------------------+
-| the design | can link some Java | can link all |
-| documentation | packages | packages |
-| packages could be | | |
-| linked withing the | | |
-| architectural | | |
-| documentation | | |
-+-----------------------+-----------------------+--------------------+
-| concepts could be | | |
-| linked with the | | |
-| classes that | | |
-| eventially | | |
-| implement it | | |
-+-----------------------+-----------------------+--------------------+
+.. figure:: table
+ :environment: table
+ :label: linking
+
+ Linking UML diagram elements to Javadoc.
+
+ +---------------------+---------------------+--------------------+
+ | Conceptual | Specification | Implementation |
+ +=====================+=====================+====================+
+ | probably no links | can link Java | can link all |
+ | to javadoc | interface and | classes |
+ | | some classes | |
+ +---------------------+---------------------+--------------------+
+ | the design | can link also Java | can link all |
+ | documentation | packages | packages |
+ | packages could be | | |
+ | linked withing the | | |
+ | architectural | | |
+ | documentation | | |
+ +---------------------+---------------------+--------------------+
+ | concepts could be | | |
+ | linked with the | | |
+ | classes that | | |
+ | eventially | | |
+ | implement it | | |
+ +---------------------+---------------------+--------------------+
The UML diagrams enable navigation in various purposes. Applying
Trigg's taxonomy of different link types [trigg83link-taxonomy]_, we
@@ -468,7 +480,7 @@
.. figure:: umldoc-linking.gen.eps
:width: 15cm
- :alternative: *
+ :environment: figure*
:label: diagramlinks
Semantic meanings of traversing the bi-directional links of a diagram.
Index: manuscripts/UMLLink/umldoc-flow.dia
diff -u manuscripts/UMLLink/umldoc-flow.dia:1.5
manuscripts/UMLLink/umldoc-flow.dia:1.6
--- manuscripts/UMLLink/umldoc-flow.dia:1.5 Sat Feb 15 04:02:16 2003
+++ manuscripts/UMLLink/umldoc-flow.dia Sat Feb 15 05:24:56 2003
@@ -170,13 +170,13 @@
</dia:object>
<dia:object type="Flowchart - Terminal" version="0" id="O4">
<dia:attribute name="obj_pos">
- <dia:point val="1.03155,1.04446"/>
+ <dia:point val="1.03155,0.99446"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="0.98155,0.99446;9.76873,3.03936"/>
+ <dia:rectangle val="0.98155,0.94446;9.76873,2.98936"/>
</dia:attribute>
<dia:attribute name="elem_corner">
- <dia:point val="1.03155,1.04446"/>
+ <dia:point val="1.03155,0.99446"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="8.68718"/>
@@ -208,7 +208,7 @@
<dia:real val="0.7"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="5.37514,2.2032"/>
+ <dia:point val="5.37514,2.1532"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
@@ -221,13 +221,13 @@
</dia:object>
<dia:object type="Flowchart - Terminal" version="0" id="O5">
<dia:attribute name="obj_pos">
- <dia:point val="11.0278,0.14446"/>
+ <dia:point val="11.0778,0.14446"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="10.9778,0.09446;24.8433,3.08301"/>
+ <dia:rectangle val="11.0278,0.09446;24.8933,3.08301"/>
</dia:attribute>
<dia:attribute name="elem_corner">
- <dia:point val="11.0278,0.14446"/>
+ <dia:point val="11.0778,0.14446"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="13.7655"/>
@@ -260,7 +260,7 @@
<dia:real val="0.7"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="17.9106,1.42503"/>
+ <dia:point val="17.9606,1.42503"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
@@ -375,13 +375,13 @@
</dia:object>
<dia:object type="Flowchart - Terminal" version="0" id="O8">
<dia:attribute name="obj_pos">
- <dia:point val="18.47,16.9945"/>
+ <dia:point val="18.37,16.9445"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="18.42,16.9445;26.4066,18.95"/>
+ <dia:rectangle val="18.32,16.8945;26.3066,18.9"/>
</dia:attribute>
<dia:attribute name="elem_corner">
- <dia:point val="18.47,16.9945"/>
+ <dia:point val="18.37,16.9445"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="7.88656"/>
@@ -413,7 +413,7 @@
<dia:real val="0.7"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="22.4133,18.1336"/>
+ <dia:point val="22.3133,18.0836"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
@@ -426,13 +426,13 @@
</dia:object>
<dia:object type="Flowchart - Ellipse" version="0" id="O9">
<dia:attribute name="obj_pos">
- <dia:point val="2.60635,6.84446"/>
+ <dia:point val="2.65635,6.84446"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="2.55635,6.79446;8.11873,12.3584"/>
+ <dia:rectangle val="2.60635,6.79446;8.16873,12.3584"/>
</dia:attribute>
<dia:attribute name="elem_corner">
- <dia:point val="2.60635,6.84446"/>
+ <dia:point val="2.65635,6.84446"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="5.46238"/>
@@ -458,7 +458,7 @@
<dia:real val="0.7"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="5.33754,9.76273"/>
+ <dia:point val="5.38754,9.76273"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
@@ -471,14 +471,14 @@
</dia:object>
<dia:object type="FS - Flow" version="0" id="O10">
<dia:attribute name="obj_pos">
- <dia:point val="5.37514,2.98936"/>
+ <dia:point val="5.37514,2.93936"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="4.93707,2.93887;8.89605,6.89836"/>
+ <dia:rectangle val="4.98738,2.8892;8.92553,6.89573"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
- <dia:point val="5.37514,2.98936"/>
- <dia:point val="5.33754,6.84446"/>
+ <dia:point val="5.37514,2.93936"/>
+ <dia:point val="5.38754,6.84446"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
@@ -492,7 +492,7 @@
<dia:real val="0.6"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="7.12065,5.27409"/>
+ <dia:point val="7.15013,5.23065"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#cc00cc"/>
@@ -512,13 +512,13 @@
</dia:object>
<dia:object type="FS - Flow" version="0" id="O11">
<dia:attribute name="obj_pos">
- <dia:point val="5.33754,12.3084"/>
+ <dia:point val="5.38754,12.3084"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="4.97357,12.258;8.4952,16.9477"/>
+ <dia:rectangle val="4.9738,12.2583;8.51337,16.9457"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
- <dia:point val="5.33754,12.3084"/>
+ <dia:point val="5.38754,12.3084"/>
<dia:point val="5.37395,16.8945"/>
</dia:attribute>
<dia:attribute name="text">
@@ -533,7 +533,7 @@
<dia:real val="0.6"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="6.8782,15.2195"/>
+ <dia:point val="6.89637,15.236"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#cc00cc"/>
@@ -553,13 +553,13 @@
</dia:object>
<dia:object type="FS - Flow" version="0" id="O12">
<dia:attribute name="obj_pos">
- <dia:point val="17.9106,3.03301"/>
+ <dia:point val="17.9606,3.03301"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="14.1429,2.98181;18.3717,5.55419"/>
+ <dia:rectangle val="14.1509,2.98281;18.3708,5.54609"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
- <dia:point val="17.9106,3.03301"/>
+ <dia:point val="17.9606,3.03301"/>
<dia:point val="17.9706,5.49446"/>
</dia:attribute>
<dia:attribute name="text">
@@ -574,7 +574,7 @@
<dia:real val="0.6"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="15.9282,5.11946"/>
+ <dia:point val="15.9362,5.07823"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#cc00cc"/>
@@ -638,11 +638,11 @@
<dia:point val="19.7494,14.2724"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="19.6787,14.2017;24.2272,17.31"/>
+ <dia:rectangle val="19.6787,14.2017;24.1693,17.2575"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="19.7494,14.2724"/>
- <dia:point val="22.4133,16.9945"/>
+ <dia:point val="22.3133,16.9445"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
@@ -656,7 +656,7 @@
<dia:real val="0.6"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="22.4782,15.1695"/>
+ <dia:point val="22.4203,15.1454"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#cc00cc"/>
@@ -1264,13 +1264,13 @@
</dia:object>
<dia:object type="FS - Flow" version="0" id="O28">
<dia:attribute name="obj_pos">
- <dia:point val="23.7277,18.9"/>
+ <dia:point val="23.6277,18.85"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="23.2831,18.8495;27.2583,23.3461"/>
+ <dia:rectangle val="23.283,18.7994;27.2304,23.3471"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
- <dia:point val="23.7277,18.9"/>
+ <dia:point val="23.6277,18.85"/>
<dia:point val="23.6836,23.2921"/>
</dia:attribute>
<dia:attribute name="text">
@@ -1285,7 +1285,7 @@
<dia:real val="0.6"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="25.5093,22.087"/>
+ <dia:point val="25.4814,22.0321"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#cc00cc"/>
Index: manuscripts/UMLLink/umltool-example-uml-linked.dia
diff -u manuscripts/UMLLink/umltool-example-uml-linked.dia:1.5
manuscripts/UMLLink/umltool-example-uml-linked.dia:1.6
--- manuscripts/UMLLink/umltool-example-uml-linked.dia:1.5 Sat Feb 15
04:34:50 2003
+++ manuscripts/UMLLink/umltool-example-uml-linked.dia Sat Feb 15 05:24:56 2003
@@ -58,10 +58,10 @@
<dia:layer name="Tausta" visible="true">
<dia:object type="Standard - Text" version="0" id="O0">
<dia:attribute name="obj_pos">
- <dia:point val="16.535,2.045"/>
+ <dia:point val="16.535,1.995"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="16.535,1.37786;31.2458,26.3279"/>
+ <dia:rectangle val="16.535,1.32786;31.2458,26.2779"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
@@ -105,7 +105,7 @@
<dia:real val="0.8"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="16.535,2.045"/>
+ <dia:point val="16.535,1.995"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
@@ -118,16 +118,16 @@
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O1">
<dia:attribute name="obj_pos">
- <dia:point val="30.0198,22.8699"/>
+ <dia:point val="30.0198,22.7699"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="29.9751,22.3982;30.841,23.2706"/>
+ <dia:rectangle val="29.9751,22.2982;30.841,23.1706"/>
</dia:attribute>
<dia:attribute name="bez_points">
- <dia:point val="30.0198,22.8699"/>
- <dia:point val="31.2985,22.9332"/>
- <dia:point val="30.7192,22.3263"/>
- <dia:point val="30.4433,22.4367"/>
+ <dia:point val="30.0198,22.7699"/>
+ <dia:point val="31.2985,22.8332"/>
+ <dia:point val="30.7192,22.2263"/>
+ <dia:point val="30.4433,22.3367"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
@@ -148,16 +148,16 @@
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O2">
<dia:attribute name="obj_pos">
- <dia:point val="29.9592,21.9979"/>
+ <dia:point val="29.9592,21.8979"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="29.9145,21.5262;30.7804,22.3986"/>
+ <dia:rectangle val="29.9145,21.4262;30.7804,22.2986"/>
</dia:attribute>
<dia:attribute name="bez_points">
- <dia:point val="29.9592,21.9979"/>
- <dia:point val="31.2379,22.0612"/>
- <dia:point val="30.6586,21.4543"/>
- <dia:point val="30.3828,21.5647"/>
+ <dia:point val="29.9592,21.8979"/>
+ <dia:point val="31.2379,21.9612"/>
+ <dia:point val="30.6586,21.3543"/>
+ <dia:point val="30.3828,21.4647"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
@@ -231,16 +231,16 @@
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O4">
<dia:attribute name="obj_pos">
- <dia:point val="14.6953,18.0042"/>
+ <dia:point val="14.9453,18.0042"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="14.6506,17.5325;15.5165,18.4049"/>
+ <dia:rectangle val="14.9006,17.5325;15.7665,18.4049"/>
</dia:attribute>
<dia:attribute name="bez_points">
- <dia:point val="14.6953,18.0042"/>
- <dia:point val="15.974,18.0675"/>
- <dia:point val="15.3947,17.4606"/>
- <dia:point val="15.1188,17.571"/>
+ <dia:point val="14.9453,18.0042"/>
+ <dia:point val="16.224,18.0675"/>
+ <dia:point val="15.6447,17.4606"/>
+ <dia:point val="15.3688,17.571"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
@@ -261,16 +261,16 @@
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O5">
<dia:attribute name="obj_pos">
- <dia:point val="14.6863,17.1516"/>
+ <dia:point val="14.9363,17.1516"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="14.6416,16.6799;15.5075,17.5523"/>
+ <dia:rectangle val="14.8916,16.6799;15.7575,17.5523"/>
</dia:attribute>
<dia:attribute name="bez_points">
- <dia:point val="14.6863,17.1516"/>
- <dia:point val="15.9651,17.2149"/>
- <dia:point val="15.3858,16.608"/>
- <dia:point val="15.1099,16.7184"/>
+ <dia:point val="14.9363,17.1516"/>
+ <dia:point val="16.2151,17.2149"/>
+ <dia:point val="15.6358,16.608"/>
+ <dia:point val="15.3599,16.7184"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>