120 |
* (XXX Free Software vs. Open Source vs. Open Software vs. Open Project...) |
* (XXX Free Software vs. Open Source vs. Open Software vs. Open Project...) |
121 |
|
|
122 |
|
|
123 |
|
Diagrams |
124 |
|
======== |
125 |
|
|
126 |
|
|
127 |
|
|
128 |
Introduction |
Introduction |
129 |
============ |
============ |
130 |
|
|
136 |
semantically dependent, in practice they are often linked scarcely -- if at |
semantically dependent, in practice they are often linked scarcely -- if at |
137 |
all. |
all. |
138 |
|
|
139 |
The Unified Modeling Language (UML) is the standard way to visually describe |
The Unified Modeling Language (UML) is the standard way to XXX visually |
140 |
software constructs in diagrams. It was originally developed for descriptions |
describe software constructs in diagrams _[#]. It was originally developed |
141 |
|
for descriptions |
142 |
on an abstract level (many constructs cannot be directly expressed in |
on an abstract level (many constructs cannot be directly expressed in |
143 |
any programming language), but current trend is to use it also on the concrete |
any programming language) _[#], but current trend is to use it also on the |
144 |
|
concrete |
145 |
level, as to fully unify the architectural documentation and program code: the |
level, as to fully unify the architectural documentation and program code: the |
146 |
program code might be generated from highly detailed diagrams, or exact |
program code might be generated from highly detailed diagrams _[#], or exact |
147 |
diagrams be produced from the source code. |
diagrams be produced from the source code _[#]. |
148 |
|
|
149 |
|
|
150 |
|
.. [#] ``XXX`` booch-jacobson-rumbaugh-uml-user-guide? |
151 |
|
|
152 |
|
.. [#] booch-jacobson-rumbaugh-uml-user-guide p.15 |
153 |
|
booch-jacobson-rumbaugh-uml-reference-manual p.4 |
154 |
|
|
155 |
|
.. [#] harrison-barton-raghavachari00uml-to-java |
156 |
|
|
157 |
|
.. [#] pierce-tilley02connecting-documentation-rose |
158 |
|
|
159 |
|
|
160 |
Against this trend, we still use UML only to plan and document our software |
Against this trend, we still use UML only to plan and document our software |
161 |
architecture on general level. UML functions as a common language for |
architecture on general level. UML functions as a common language for |
218 |
Up to this article all steps except the last one are implemented. The |
Up to this article all steps except the last one are implemented. The |
219 |
existing tools we selected as the basis for our documentation tool are: |
existing tools we selected as the basis for our documentation tool are: |
220 |
Javadoc [XXX], Docutils [XXX], and our own UML diagram description |
Javadoc [XXX], Docutils [XXX], and our own UML diagram description |
221 |
tool. The UML tools also use several free utilies to convert |
tool. Further, the UML tool uses several free utilies to convert |
222 |
the lexical UML description into final *Portable Network |
each lexical UML description into final *Portable Network |
223 |
Graphics* (PNG) diagram files. Such utilies are *MetaPost* [XXX] (mpost), |
Graphics* (PNG) diagram files. Such utilies are *MetaPost* [XXX] (mpost), |
224 |
which implements a language for picture drawing, and Netpbm image file |
which implements a language for picture drawing, and Netpbm image file |
225 |
manipulation toolkit. Besides Javadoc, all tools used are Free |
manipulation toolkit. Besides Javadoc, all tools used are Free |