136 |
Abstract |
Abstract |
137 |
======== |
======== |
138 |
|
|
139 |
We describe automatic linking of design documentation to javadoc |
We describe automatic linking of software engineering design documentation to javadoc |
140 |
through UML diagrams embedded in both, acting as multi-target nexus links. |
through UML diagrams embedded in both, acting as multi-target nexus links. |
141 |
Our simple implementation as a Free Software toolchain is in daily use |
Our simple implementation as a Free Software toolchain is in daily use |
142 |
in our project. |
in our project. |
150 |
Software projects manage a large base of evolving documentation, which |
Software projects manage a large base of evolving documentation, which |
151 |
is inter-related on many levels. Design documentation gives |
is inter-related on many levels. Design documentation gives |
152 |
architectural views on a more general level, while the program code |
architectural views on a more general level, while the program code |
153 |
source files contain interfaces and embedded documentation |
source files contain interfaces and often embedded documentation |
154 |
giving all the minute details on how the computer should act. Although |
giving details on how the interfaces should be used. Although |
155 |
these two parts of documentation are semantically dependent, linking |
these two parts of documentation are semantically dependent, linking |
156 |
them is tedious -- if even possible -- when they are authored using different |
them is tedious -- if even possible -- when they are authored using different |
157 |
software. |
software. |