← Back to branch summary

~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.DebugClients.Python.Cyclops.RunCyclops.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
eric/Documentation/Source/eric4.DebugClients.Python.Cyclops.RunCyclops.html
 
1
<?xml version="1.0" encoding="utf-8"?>
 
2
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
 
3
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
 
4
<html><head>
 
5
<title>eric4.DebugClients.Python.Cyclops.RunCyclops</title>
 
6
<style>
 
7
body {
 
8
    background:white;
 
9
    margin: 0em 1em 10em 1em;
 
10
    color: black;
 
11
}
 
12
 
 
13
h1 { color: white; background: #4FA4FF; }
 
14
h2 { color: white; background: #4FA4FF; }
 
15
h3 { color: white; background: #00557F; }
 
16
h4 { color: white; background: #00557F; }
 
17
    
 
18
a { color: #AA5500; }
 
19
 
 
20
</style>
 
21
</head>
 
22
<body><a NAME="top" ID="top"></a>
 
23
<h1>eric4.DebugClients.Python.Cyclops.RunCyclops</h1>
 
24
<p>
 
25
Module implementing a function to run the Cyclops cycle finder on a module. 
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr><td>None</td></tr>
 
30
</table>
 
31
<h3>Functions</h3>
 
32
<table>
 
33
<tr>
 
34
<td><a href="#func_refs">func_refs</a></td>
 
35
<td>Function returning a sequence of all objects directly reachable from x.</td>
 
36
</tr><tr>
 
37
<td><a href="#func_tag">func_tag</a></td>
 
38
<td>Function returning a string describing how the reference was obtained from x.</td>
 
39
</tr><tr>
 
40
<td><a href="#generateReport">generateReport</a></td>
 
41
<td>Function to generate the report.</td>
 
42
</tr><tr>
 
43
<td><a href="#instance_filter">instance_filter</a></td>
 
44
<td>Function to filter the cycles.</td>
 
45
</tr><tr>
 
46
<td><a href="#mod_refs">mod_refs</a></td>
 
47
<td>Function returning a sequence of all objects directly reachable from x.</td>
 
48
</tr><tr>
 
49
<td><a href="#mod_tag">mod_tag</a></td>
 
50
<td>Function returning a string describing how the reference was obtained from x.</td>
 
51
</tr><tr>
 
52
<td><a href="#run">run</a></td>
 
53
<td>Function to run the program in the cyclops cycle finder.</td>
 
54
</tr>
 
55
</table>
 
56
<hr /><hr />
 
57
<a NAME="func_refs" ID="func_refs"></a>
 
58
<h2>func_refs</h2>
 
59
<b>func_refs</b>(<i>x</i>)
 
60
<p>
 
61
    Function returning a sequence of all objects directly reachable from x.
 
62
</p><dl>
 
63
<dt><i>x</i></dt>
 
64
<dd>
 
65
object to check
 
66
</dd>
 
67
</dl><dl>
 
68
<dt>Returns:</dt>
 
69
<dd>
 
70
sequence of all objects directly reachable from x
 
71
</dd>
 
72
</dl>
 
73
<div align="right"><a href="#top">Up</a></div>
 
74
<hr /><hr />
 
75
<a NAME="func_tag" ID="func_tag"></a>
 
76
<h2>func_tag</h2>
 
77
<b>func_tag</b>(<i>x, i</i>)
 
78
<p>
 
79
    Function returning a string describing how the reference was obtained from x.
 
80
</p><dl>
 
81
<dt><i>x</i></dt>
 
82
<dd>
 
83
object to check
 
84
</dd><dt><i>i</i></dt>
 
85
<dd>
 
86
index into list of references
 
87
</dd>
 
88
</dl><dl>
 
89
<dt>Returns:</dt>
 
90
<dd>
 
91
a string describing how the reference was obtained from x
 
92
</dd>
 
93
</dl>
 
94
<div align="right"><a href="#top">Up</a></div>
 
95
<hr /><hr />
 
96
<a NAME="generateReport" ID="generateReport"></a>
 
97
<h2>generateReport</h2>
 
98
<b>generateReport</b>(<i>z, reports</i>)
 
99
<p>
 
100
    Function to generate the report.
 
101
</p>
 
102
<div align="right"><a href="#top">Up</a></div>
 
103
<hr /><hr />
 
104
<a NAME="instance_filter" ID="instance_filter"></a>
 
105
<h2>instance_filter</h2>
 
106
<b>instance_filter</b>(<i>cycle</i>)
 
107
<p>
 
108
    Function to filter the cycles.
 
109
</p><dl>
 
110
<dt>Returns:</dt>
 
111
<dd>
 
112
flag indicating that at least one instance object was found
 
113
</dd>
 
114
</dl>
 
115
<div align="right"><a href="#top">Up</a></div>
 
116
<hr /><hr />
 
117
<a NAME="mod_refs" ID="mod_refs"></a>
 
118
<h2>mod_refs</h2>
 
119
<b>mod_refs</b>(<i>x</i>)
 
120
<p>
 
121
    Function returning a sequence of all objects directly reachable from x.
 
122
</p><dl>
 
123
<dt><i>x</i></dt>
 
124
<dd>
 
125
object to check
 
126
</dd>
 
127
</dl><dl>
 
128
<dt>Returns:</dt>
 
129
<dd>
 
130
sequence of all objects directly reachable from x
 
131
</dd>
 
132
</dl>
 
133
<div align="right"><a href="#top">Up</a></div>
 
134
<hr /><hr />
 
135
<a NAME="mod_tag" ID="mod_tag"></a>
 
136
<h2>mod_tag</h2>
 
137
<b>mod_tag</b>(<i>x, i</i>)
 
138
<p>
 
139
    Function returning a string describing how the reference was obtained from x.
 
140
</p><dl>
 
141
<dt><i>x</i></dt>
 
142
<dd>
 
143
object to check
 
144
</dd><dt><i>i</i></dt>
 
145
<dd>
 
146
index into list of references
 
147
</dd>
 
148
</dl><dl>
 
149
<dt>Returns:</dt>
 
150
<dd>
 
151
a string describing how the reference was obtained from x
 
152
</dd>
 
153
</dl>
 
154
<div align="right"><a href="#top">Up</a></div>
 
155
<hr /><hr />
 
156
<a NAME="run" ID="run"></a>
 
157
<h2>run</h2>
 
158
<b>run</b>(<i>filename, modfunc, reports, dbgClient</i>)
 
159
<p>
 
160
    Function to run the program in the cyclops cycle finder.
 
161
</p><dl>
 
162
<dt><i>filename</i></dt>
 
163
<dd>
 
164
filename of the module to be run (string)
 
165
</dd><dt><i>modfunc</i></dt>
 
166
<dd>
 
167
module function which is the main entry point (string)
 
168
</dd><dt><i>reports</i></dt>
 
169
<dd>
 
170
bit mask specifying the reports wanted (integer)
 
171
</dd>
 
172
</dl>
 
173
<div align="right"><a href="#top">Up</a></div>
 
174
<hr />
 
175
</body></html>
 
 
b'\\ No newline at end of file'