/[gzz]/manuscripts/UMLLink/short-paper.rst
ViewVC logotype

Diff of /manuscripts/UMLLink/short-paper.rst

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

revision 1.21 by humppake, Wed May 21 10:41:02 2003 UTC revision 1.22 by humppake, Wed May 21 13:42:19 2003 UTC
# Line 20  Bridging Javadoc and design documentatio Line 20  Bridging Javadoc and design documentatio
20     Work by Maletic on automatically finding connections among software     Work by Maletic on automatically finding connections among software
21     documents using LSI     documents using LSI
22     - [humppake] 'automatically', probably not relewant     - [humppake] 'automatically', probably not relewant
23       - [humppake] From Maletic, but doesn't seem relevant:
24                    http://doi.acm.org/10.1145/585058.585066
25    
26     Berkeley PhD dissertation by Linton on using RDBMS to store program     Berkeley PhD dissertation by Linton on using RDBMS to store program
27     analysis information     analysis information
# Line 73  for several languages Line 75  for several languages
75  [friendly95javadoc-andalso-heesch03doxygen-andalso-devanbu99chime]_.  [friendly95javadoc-andalso-heesch03doxygen-andalso-devanbu99chime]_.
76  Similarly, requirements tracing --- managing relations  Similarly, requirements tracing --- managing relations
77  between requirements and design decisions is relatively  between requirements and design decisions is relatively
78  well developed [XXX]_.  well developed [gotel94reqtracing-andalso-jarke98reqtracing]_.
79    
80  What is often missing is the connections between  What is often missing is the connections between
81  the design documentation and the embedded documentation.  the design documentation and the embedded documentation.
82  This can be daunting to a newcomer; consider the javadoc  This can be daunting to a newcomer; consider the javadoc
83  for the interface ``java.security.PublicKey`` in Sun's  for the interface ``java.security.PublicKey`` in Sun's
84  Java2 SDK 1.4.1  Java2 SDK 1.4.1.
85  REF?.  
86    .. REF?. XXX
87    
88  While the class is easy to find through the package and class lists  While the class is easy to find through the package and class lists
89  when looking for a class to represent cryptographical public keys,  when looking for a class to represent cryptographical public keys,
90  the javadoc is not terribly useful: there is no information  the javadoc is not terribly useful: there is no information
# Line 182  described in the diagram, it should also Line 186  described in the diagram, it should also
186  through the spatial menu in the diagram --- we insert  through the spatial menu in the diagram --- we insert
187  elements showing the location where the diagram appears  elements showing the location where the diagram appears
188  in the design documentation into the diagrams as well.  in the design documentation into the diagrams as well.
189  Figure XXX shows some example HTML pages produced by our system.  Figure 1 [ref-example]_ shows some example HTML pages produced by our system.
190    
191    
192  ..  Because UML diagrams should be made anyway, it is good start to  ..  Because UML diagrams should be made anyway, it is good start to
# Line 220  Figure XXX shows some example HTML pages Line 224  Figure XXX shows some example HTML pages
224  The implementation in Navidoc  The implementation in Navidoc
225  =============================  =============================
226    
227    * using lexical UML language  Navidoc is as a light-weight tool built on top of several existing
228    Free Software [fsf02categories]_ tools.
229    
230    - main parts: Docutils [goodger02docutils]_, lexical UML language
231    
232    Navidoc uses several free utilies to convert each
233    lexical UML diagram description into final *Portable Network Graphics*
234    (PNG) diagram files. Such utilies are *MetaPost* [hobby89metapost]_
235    (mpost), which implements a language for picture drawing, and Netpbm
236    image file manipulation toolkit.
237    
238  - why lexical UML language:  - why lexical UML language:
239    

Legend:
Removed from v.1.21  
changed lines
  Added in v.1.22

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