/[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.15 by tjl, Wed May 21 05:59:36 2003 UTC revision 1.16 by tjl, Wed May 21 06:03:57 2003 UTC
# Line 198  together create a multicontext view for Line 198  together create a multicontext view for
198  Making it easy  Making it easy
199  ==============  ==============
200    
 It is not a new idea to use UML diagrams in documentation  
 navigation. There already exists Javadoc like documentation generation  
 tools, which generate automaticly classdiagrams from program source  
 code to help navigation in generated documentation.  
 Doxygen [heesch03doxygen]_,  
 for example, generates diagrams of class  
 inheritance tree for that purpose.  
   
201  Of course, generated documentation may give well detailed information  Of course, generated documentation may give well detailed information
202  from the current implementation, but the design documentation should  from the current implementation, but the design documentation should
203  also cover the future and be rather well abstracted than well  also cover the future and be rather well abstracted than well
# Line 273  Usage Line 265  Usage
265  Conclusion  Conclusion
266  ==========  ==========
267    
268    It is not a new idea to use UML diagrams in documentation
269    navigation. There already exists Javadoc like documentation generation
270    tools, which generate automaticly classdiagrams from program source
271    code to help navigation in generated documentation.
272    Doxygen [heesch03doxygen]_,
273    for example, generates diagrams of class
274    inheritance tree for that purpose.
275    
276    - other analysis software
277    
278    - autogen not comparable to design doc
279    
280  Our approach is different from most tools,  Our approach is different from most tools,
281  which rely more on automatically generated links [XXX],  which rely more on automatically generated links [XXX],
282  or inserting connections to the source code [devanbu99chime]_.  or inserting connections to the source code [devanbu99chime]_.

Legend:
Removed from v.1.15  
changed lines
  Added in v.1.16

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