/[gzz]/manuscripts/UMLLink/article.rst
ViewVC logotype

Diff of /manuscripts/UMLLink/article.rst

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.107 by tuukkah, Sat Feb 15 23:44:58 2003 UTC revision 1.108 by humppake, Sat Feb 15 23:48:13 2003 UTC
# Line 560  is still unreachable. Line 560  is still unreachable.
560  .. Advantage over paper: SOME: see the UML diagram contexts of a class,  .. Advantage over paper: SOME: see the UML diagram contexts of a class,
561     traverse them     traverse them
562    
563  **Step 3; From Javadoc through a UML diagram to a design document.**  **Step 3; From Javadoc through a UML diagram to a design document.**
564  Even though the design documents were not included  Even though the design documents were not included in the original UML
565  in the original UML diagrams, they are included in the final  diagrams, they are included in the final image on top of the diagram
566  image on top of the diagram. Including **all** the contexts where  [ref-screenshot]_. Including **all** the contexts where the diagram
567  the diagram appears as links  appears as links in the graphical image creates a consistent whole - a
568  in the graphical  spatial focus+context menu.  The element that represents the current
569  image creates a consistent whole - a spatial focus+context menu.  hypertext node is emphasized (colored and also circled) for clarity.
 The element that represents the current hypertext node  
 is emphasized (colored and also circled) for clarity.    
570    
571  Because the original location on the diagrams is easily reachable from  Because the original location on the diagrams is easily reachable from
572  its every implicit occurerrence in Javadoc or in design documentation,  its every implicit occurerrence in Javadoc or in design documentation,
# Line 590  documentation more clear. Line 588  documentation more clear.
588  For Step 1, we keep it best to demand explicit links in the UML  For Step 1, we keep it best to demand explicit links in the UML
589  diagrams. Author has to decide for each object in UML diagram whether  diagrams. Author has to decide for each object in UML diagram whether
590  it should be linked, for example, by giving a fully-qualified java  it should be linked, for example, by giving a fully-qualified java
591  class name or a relative path to design documentation page. After Step  class name or a relative path to design documentation page
592  1 from author's perspective, the computer has *all* the information  [ref-umltoolumlsourcelinked]_. After Step 1 from author's perspective,
593  needed to complete also steps 2 and 3, so *no further changes should  the computer has *all* the information needed to complete also steps 2
594  be required*. For example javadoc comments should not need changes at  and 3, so *no further changes should be required*. For example javadoc
595  all.  comments should not need changes at all.
596    
597  During steps 2 and 3 computer simply embeds diagrams into previously linked  During steps 2 and 3 computer simply embeds diagrams into previously linked
598  documentation pages and creates backlinks to the initiating documentation  documentation pages and creates backlinks to the initiating documentation

Legend:
Removed from v.1.107  
changed lines
  Added in v.1.108

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26