1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2
<!--Converted with LaTeX2HTML 98.1p1 release (March 2nd, 1998)
3
originally by Nikos Drakos (nikos@cbl.leeds.ac.uk), CBLU, University of Leeds
4
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
5
* with significant contributions from:
6
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
9
<TITLE>5. TCM Class Hierarchy</TITLE>
10
<META NAME="description" CONTENT="5. TCM Class Hierarchy">
11
<META NAME="keywords" CONTENT="TechDoc">
12
<META NAME="resource-type" CONTENT="document">
13
<META NAME="distribution" CONTENT="global">
14
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
15
<LINK REL="STYLESHEET" HREF="TechDoc.css">
16
<LINK REL="next" HREF="developersguidenode7.html">
17
<LINK REL="previous" HREF="developersguidenode5.html">
18
<LINK REL="up" HREF="TechDoc.html">
19
<LINK REL="next" HREF="developersguidenode7.html">
22
<!--Navigation Panel-->
24
HREF="developersguidenode7.html">
25
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next_motif.gif"></A>
28
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up_motif.gif"></A>
30
HREF="developersguidenode5.html">
31
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="previous_motif.gif"></A>
33
HREF="developersguidenode1.html">
34
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents_motif.gif"></A>
36
<B> Next:</B> <A NAME="tex2html333"
37
HREF="developersguidenode7.html">6. Output Files</A>
38
<B> Up:</B> <A NAME="tex2html330"
39
HREF="TechDoc.html">Toolkit for Conceptual Modeling</A>
40
<B> Previous:</B> <A NAME="tex2html324"
41
HREF="developersguidenode5.html">4. TCM User Interface</A>
44
<!--End of Navigation Panel-->
46
<H1><A NAME="SECTION00600000000000000000"> </A> <A NAME="chap:class_hierarchy"> </A>
48
5. TCM Class Hierarchy
52
A representation of the C++ class hierarchy can be automatically
53
generated with <TT>doc++</TT>. <TT>doc++</TT> is a documentation system for C++
54
programs capable of generating output for HTML and L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X.
55
<TT>doc++</TT> follows the approach of maintaining one source
56
code that contains both the C++ program itself
57
along with the documentation in order to avoid
58
incompatibilities between the program and its documentation.
59
<TT>doc++</TT> documentation is solely hidden in standard C++
60
comments (the text that appears in the doc++ files is C++ comment that
61
starts with <TT>//</TT>, instead of the standard C++ convention to start
62
comment with <TT>///</TT>). <TT>doc++</TT> is free software, subject to the GNU
63
PUBLIC LICENSE. It is included in the TCM documentation source distribution and
64
it can be found in the <A NAME="tex2html161"
65
HREF="../docsrc/docxx"><TT>doc/docsrc/docxx</TT></A>
66
subdirectory or it can be
67
downloaded from <A NAME="tex2html162"
68
HREF="http://www.zib.de/Visual/software/doc++/index.html"><TT>http://www.zib.de/Visual/software/doc++/index.html</TT></A>.
71
A <TT>doc++</TT> L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X document of the entire TCM source tree can
72
be made automatically and from that HTML and PostScript documents
73
can be generated. These documents can be found in <BR>
75
HREF="../sourcecode/index.html"><TT>doc/sourcecode/index.html</TT></A>
76
and <A NAME="tex2html164"
77
HREF="../sourcecode-2.0.ps.gz"><TT>doc/sourcecode-2.0.ps.gz</TT></A>.
80
The classes in the L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X document generated by <TT>doc++</TT> are alphabetically
81
ordered. Each class has a section which consists of a picture of its base class and
82
its derived classes, a list of its public and protected members plus
83
relevant comment. As the files reside in different directories and
84
are used in different libraries or executables, its `scope' is
85
mentioned at the end of the listing of a class.
86
At the end of the <TT>doc++</TT> documentation you can find the entire class
87
specialization graph. In the HTML documentation generated by <TT>doc++</TT>, a
88
distinct HTML page is generated per C++ class. Connections between classes
89
(variables, function arguments, base/derived classes) are automatically
90
translated to HTML-links and there is an index file which contains links to
91
all classes in alphabetic order.
95
<!--Navigation Panel-->
97
HREF="developersguidenode7.html">
98
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next_motif.gif"></A>
101
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up_motif.gif"></A>
102
<A NAME="tex2html323"
103
HREF="developersguidenode5.html">
104
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="previous_motif.gif"></A>
105
<A NAME="tex2html331"
106
HREF="developersguidenode1.html">
107
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents_motif.gif"></A>
109
<B> Next:</B> <A NAME="tex2html333"
110
HREF="developersguidenode7.html">6. Output Files</A>
111
<B> Up:</B> <A NAME="tex2html330"
112
HREF="TechDoc.html">Toolkit for Conceptual Modeling</A>
113
<B> Previous:</B> <A NAME="tex2html324"
114
HREF="developersguidenode5.html">4. TCM User Interface</A>
115
<!--End of Navigation Panel-->
117
<I>Henk van de Zandschulp</I>
118
<BR><I>2003-01-07</I>
added
removed
doc/developersguide/developersguidenode6.html
