w07-bsc-uml-diagram
UML Diagram
The inheritance of classes and their relation is well visualized by UML diagrams. Here, you will generate a software catalogue that includes also various UML diagrams. We will generate this catalogue (and the UML diagrams) automatically using the doxygen
and graphviz
software.
Here, we will generate this software catalogue for the three classes implemented in the tehpc/basics/inheritance_basics.cpp
file.
Follow these instructions:
- load appropriate modules by performing the following command in your terminal:
source tehpc/tools/tehpc_load_modules.sh
. Note that this now includes loading of modules fordoxygen
andgraphviz
. - go into the
tehpc/build/
folder (possibly in another terminal) - type: either
cmake -DCMAKE_BUILD_TYPE:STRING=Debug -DTEHPC_BASICS:STRING=ON ..
orccmake ..
and make sure that build type isDebug
andBasics
are ON (you only have to do this the very first time). - type:
make
(do this whenever you want to recompile). - To run the complied code, go into
tehpc/build/basics/
. - execute
doxygen Doxyfile.in
(which will generate absc_docs
folder) - download the
bsc_docs
folder by right-clicking -> download - on your local machine: open the
bsc_docs/html/index.html
file (with a internet browser)
Questions:
- Look at the
Doxyfile.in
file and browse through the various options. - Look at the generated doxygen software catalogue and check for the UML diagrams.