798 |
The documentation [gzz_doc_himalia]_ is created in two distinct |
The documentation [gzz_doc_himalia]_ is created in two distinct |
799 |
phases. In the first phase [ref-umldocflow]_ all reST sources are |
phases. In the first phase [ref-umldocflow]_ all reST sources are |
800 |
parsed and compiled into HTML and lexical UML diagram descriptions are |
parsed and compiled into HTML and lexical UML diagram descriptions are |
801 |
extracted into temporary storage [ref-umldocreferflow]_. Also the |
extracted into temporary storage Also the paths for reST documents |
802 |
paths for reST documents explicitly referring particular diagrams are |
explicitly referring particular diagrams are stored with that diagram |
803 |
stored with that diagram source [ref-umldocreferflow]_. In the second |
source. In the second phase all compiled reST documents are processed |
804 |
phase all compiled reST documents are processed again: |
again: |
805 |
|
|
806 |
- Focused versions of UML diagram with list of all explicitly |
- Focused versions of UML diagram with list of all explicitly |
807 |
referring reST documents are created and embedded into compiled |
referring reST documents are created and embedded into compiled |
820 |
The two distinct phases of generating Javadoc and design |
The two distinct phases of generating Javadoc and design |
821 |
documentation bridged via UML diagrams. |
documentation bridged via UML diagrams. |
822 |
|
|
|
|
|
|
.. figure:: umldoc-refer-flow.gen.eps |
|
|
:label: umldocreferflow |
|
|
|
|
|
Compiling reST sources and extracting embedded UML diagram |
|
|
descriptions into temporary storage. |
|
|
|
|
823 |
Practical use |
Practical use |
824 |
============= |
============= |
825 |
|
|