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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>Module: docset_Dia</title>
</head>
<body bgcolor="#ffffff">
<p><i><a href="../../../index.html">Table of Contents</a></i></p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th rowspan="2"
valign="top"
align="left"
width="10%"
bgcolor="#88bbee"><font color="#000000">Module: docset_Dia</font>
</th>
<th bgcolor="#88bbee"
width="90%"
align="right"><font color="#000000">../HappyDoc-r2_1/happydoclib/docset/docset_Dia.py</font>
</th>
</tr>
<tr>
<td>
<h3>Documentation set which writes output in dia format.</h3>
<h4> Some known bugs/deficiencies</h4>
<ul>
<li><p>you can NOT specify an output filename yet, it is fixed to
<code>dia.dia</code> (quite easy to solve, I just haven't had the time). The
dia file is not yet compressed, but it can be used without changes
in dia. If you save the file from within dia, it will be saved in
gzipped format (without .gz).</p></li>
<li><p>in some cases, the generalization arrows are not actually
connected to the class, but sometimes they will <code>snap</code> to the
right class when you move the class box on the screen. This
appears only (I think) if the name of the class in the dia class
font (which is a proportional font) is longer than the longest
method-name (which is displayed in a non proportional font). At
the moment I compute the size of the boxes only by calculating the
width of the string for the longest method name. I have no idea
how to get the length of the class name string :( ( I can work
around this one, if I connected the arrows to the left side of the
boxes instead of the middle, but I like it better that way.)</p></li>
<li><p>If a base class is not included in the directories the dia file
is produced from, a message will be issues <code>base_class <...> not
found</code> and a dummy UML object is created (with just one __init__
method).</p></li>
<li><p>The Layout is of course not really good (esp. for automatically
generated base classes, since they will be put in the same <code>line</code>
as the class where it is needed)</p></li>
<li><p>No package support right now. Just a matter of time ;-)</p></li>
<li><p>I assume that each class name is unique. If you have several
classes with the same name, one of the classes will have all the
generalizations arrows!</p></li>
</ul>
<h4> To Do</h4>
<ul>
<li><p>update an existing dia file if you change the python code
(e.g. just adding the new methods).</p></li>
<li><p>automatically generate python code for an UML diagram?</p></li>
<li><p>add attributes as well (matter of the parser)</p></li>
</ul>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Imported modules">Imported modules</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<b>import</b> <a href="http://www.python.org/doc/current/lib/module-copy.html">copy</a><br>
<b>import</b> happydoclib.happydocset<br>
</td></tr>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Functions">Functions</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<a href="#entryPoint">entryPoint</a><br>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="entryPoint"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">entryPoint </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
entryPoint ()
</pre></font>
<p>Return info about this module to the dynamic loader.</p>
</td></tr>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Classes">Classes</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="0">
<tr><td valign="top" align="left"><p><a href="docset_Dia/DiaDocSet.html">DiaDocSet</a></p></td><td valign="top" align="left">
<p>Documentation set written in dia format.</p>
</td></tr>
</table>
</td></tr>
</td></tr>
</table>
</td>
</tr>
</table>
<hr>
<p><i><a href="../../../index.html">Table of Contents</a></i></p>
<font size="-2"><i>This document was automatically generated
on Sat Aug 24 16:57:23 2002 by
<a href="http://happydoc.sourceforge.net">HappyDoc</a> version
2.1</i></font>
</body>
</html>
|
