5. TCM Class Hierarchy
Keywords: TechDoc

Next: 6. Output Files Up: Toolkit for Conceptual Modeling Previous: 4. TCM User Interface

#
5. TCM Class Hierarchy

A representation of the C++ class hierarchy can be automatically generated with `doc++`. `doc++` is a documentation system for C++ programs capable of generating output for HTML and LATEX. `doc++` follows the approach of maintaining one source code that contains both the C++ program itself along with the documentation in order to avoid incompatibilities between the program and its documentation. `doc++` documentation is solely hidden in standard C++ comments (the text that appears in the doc++ files is C++ comment that starts with `//`, instead of the standard C++ convention to start comment with `///`). `doc++` is free software, subject to the GNU PUBLIC LICENSE. It is included in the TCM documentation source distribution and it can be found in the `doc/docsrc/docxx` subdirectory or it can be downloaded from `http://www.zib.de/Visual/software/doc++/index.html`.

A `doc++` LATEX document of the entire TCM source tree can be made automatically and from that HTML and PostScript documents can be generated. These documents can be found in
`doc/sourcecode/index.html` and `doc/sourcecode-2.0.ps.gz`.

The classes in the LATEX document generated by `doc++` are alphabetically ordered. Each class has a section which consists of a picture of its base class and its derived classes, a list of its public and protected members plus relevant comment. As the files reside in different directories and are used in different libraries or executables, its `scope' is mentioned at the end of the listing of a class. At the end of the `doc++` documentation you can find the entire class specialization graph. In the HTML documentation generated by `doc++`, a distinct HTML page is generated per C++ class. Connections between classes (variables, function arguments, base/derived classes) are automatically translated to HTML-links and there is an index file which contains links to all classes in alphabetic order.

Next: 6. Output Files Up: Toolkit for Conceptual Modeling Previous: 4. TCM User Interface