1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 98.1p1 release (March 2nd, 1998)
originally by Nikos Drakos (nikos@cbl.leeds.ac.uk), CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>5. TCM Class Hierarchy</TITLE>
<META NAME="description" CONTENT="5. TCM Class Hierarchy">
<META NAME="keywords" CONTENT="TechDoc">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<LINK REL="STYLESHEET" HREF="TechDoc.css">
<LINK REL="next" HREF="developersguidenode7.html">
<LINK REL="previous" HREF="developersguidenode5.html">
<LINK REL="up" HREF="TechDoc.html">
<LINK REL="next" HREF="developersguidenode7.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html332"
HREF="developersguidenode7.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next_motif.gif"></A>
<A NAME="tex2html329"
HREF="TechDoc.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up_motif.gif"></A>
<A NAME="tex2html323"
HREF="developersguidenode5.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="previous_motif.gif"></A>
<A NAME="tex2html331"
HREF="developersguidenode1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents_motif.gif"></A>
<BR>
<B> Next:</B> <A NAME="tex2html333"
HREF="developersguidenode7.html">6. Output Files</A>
<B> Up:</B> <A NAME="tex2html330"
HREF="TechDoc.html">Toolkit for Conceptual Modeling</A>
<B> Previous:</B> <A NAME="tex2html324"
HREF="developersguidenode5.html">4. TCM User Interface</A>
<BR>
<BR>
<!--End of Navigation Panel-->
<H1><A NAME="SECTION00600000000000000000"> </A> <A NAME="chap:class_hierarchy"> </A>
<BR>
5. TCM Class Hierarchy
</H1>
<P>
A representation of the C++ class hierarchy can be automatically
generated with <TT>doc++</TT>. <TT>doc++</TT> is a documentation system for C++
programs capable of generating output for HTML and L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X.
<TT>doc++</TT> 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.
<TT>doc++</TT> documentation is solely hidden in standard C++
comments (the text that appears in the doc++ files is C++ comment that
starts with <TT>//</TT>, instead of the standard C++ convention to start
comment with <TT>///</TT>). <TT>doc++</TT> 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 <A NAME="tex2html161"
HREF="../docsrc/docxx"><TT>doc/docsrc/docxx</TT></A>
subdirectory or it can be
downloaded from <A NAME="tex2html162"
HREF="http://www.zib.de/Visual/software/doc++/index.html"><TT>http://www.zib.de/Visual/software/doc++/index.html</TT></A>.
<P>
A <TT>doc++</TT> L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X 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 <BR>
<A NAME="tex2html163"
HREF="../sourcecode/index.html"><TT>doc/sourcecode/index.html</TT></A>
and <A NAME="tex2html164"
HREF="../sourcecode-2.0.ps.gz"><TT>doc/sourcecode-2.0.ps.gz</TT></A>.
<P>
The classes in the L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X document generated by <TT>doc++</TT> 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 <TT>doc++</TT> documentation you can find the entire class
specialization graph. In the HTML documentation generated by <TT>doc++</TT>, 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.
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html332"
HREF="developersguidenode7.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next_motif.gif"></A>
<A NAME="tex2html329"
HREF="TechDoc.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up_motif.gif"></A>
<A NAME="tex2html323"
HREF="developersguidenode5.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="previous_motif.gif"></A>
<A NAME="tex2html331"
HREF="developersguidenode1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents_motif.gif"></A>
<BR>
<B> Next:</B> <A NAME="tex2html333"
HREF="developersguidenode7.html">6. Output Files</A>
<B> Up:</B> <A NAME="tex2html330"
HREF="TechDoc.html">Toolkit for Conceptual Modeling</A>
<B> Previous:</B> <A NAME="tex2html324"
HREF="developersguidenode5.html">4. TCM User Interface</A>
<!--End of Navigation Panel-->
<ADDRESS>
<I>Henk van de Zandschulp</I>
<BR><I>2003-01-07</I>
</ADDRESS>
</BODY>
</HTML>
|
