RadonMetrics/Documentation/source/Plugin_Metrics_Radon.PluginMetricsRadon.html

Sun, 25 Apr 2021 16:43:29 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 25 Apr 2021 16:43:29 +0200
changeset 78
4ce16e1d29f3
parent 69
cdf51e6abaee
child 80
a4f2000c6687
permissions
-rw-r--r--

Prepared new release.

14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>Plugin_Metrics_Radon.PluginMetricsRadon</title>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
21 <body>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
22 <a NAME="top" ID="top"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>Plugin_Metrics_Radon.PluginMetricsRadon</h1>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
24
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Module implementing the radon code metrics plug-in.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Global Attributes</h3>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
29
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
31 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <h3>Classes</h3>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
34
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <table>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
36
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <td><a href="#RadonMetricsPlugin">RadonMetricsPlugin</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <td>Class implementing the radon code metrics plug-in.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Functions</h3>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
43
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <tr><td>None</td></tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </table>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
47 <hr />
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
48 <hr />
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <a NAME="RadonMetricsPlugin" ID="RadonMetricsPlugin"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <h2>RadonMetricsPlugin</h2>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
51
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 Class implementing the radon code metrics plug-in.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
54 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
55 <h3>Signals</h3>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <dl>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
57
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <dt>batchFinished(str)</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 emitted when a code metrics batch is done
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
61 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
62 <dt>complexityDone(str, dict)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 emitted when the
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 cyclomatic complexity was determined for a file
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
66 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
67 <dt>error(str, str, str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 emitted in case of an error
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
70 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
71 <dt>maintainabilityIndexDone(str, dict)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 emitted when the
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 maintainability index was determined for a file
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
75 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
76 <dt>metricsDone(str, dict)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 emitted when the code metrics were
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 determined for a file
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 </dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 <h3>Derived from</h3>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 QObject
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <h3>Class Attributes</h3>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
85
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <tr><td>None</td></tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 <h3>Class Methods</h3>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
90
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <tr><td>None</td></tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <h3>Methods</h3>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
95
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <table>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
97
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 <tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <td><a href="#RadonMetricsPlugin.__init__">RadonMetricsPlugin</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <td>Constructor</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
101 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
102 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <td><a href="#RadonMetricsPlugin.__editorClosed">__editorClosed</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <td>Private slot called, when an editor was closed.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
105 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
106 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 <td><a href="#RadonMetricsPlugin.__editorCyclomaticComplexity">__editorCyclomaticComplexity</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <td>Private slot to handle the cyclomatic complexity action of the editor show menu.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
109 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
110 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <td><a href="#RadonMetricsPlugin.__editorMaintainabilityIndex">__editorMaintainabilityIndex</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <td>Private slot to handle the maintainability index action of the editor show menu.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
113 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
114 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 <td><a href="#RadonMetricsPlugin.__editorOpened">__editorOpened</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 <td>Private slot called, when a new editor was opened.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
117 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
118 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 <td><a href="#RadonMetricsPlugin.__editorRawMetrics">__editorRawMetrics</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 <td>Private slot to handle the raw code metrics action of the editor show menu.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
121 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
122 <tr>
55
755bc8e1485a Upgraded the embedded Radon library to version 2.4.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 18
diff changeset
123 <td><a href="#RadonMetricsPlugin.__editorRenamed">__editorRenamed</a></td>
755bc8e1485a Upgraded the embedded Radon library to version 2.4.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 18
diff changeset
124 <td>Private slot called, when an editor was renamed.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
125 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
126 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 <td><a href="#RadonMetricsPlugin.__editorShowMenu">__editorShowMenu</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
129 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
130 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 <td><a href="#RadonMetricsPlugin.__initialize">__initialize</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 <td>Private slot to (re)initialize the plugin.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
133 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
134 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 <td><a href="#RadonMetricsPlugin.__loadTranslator">__loadTranslator</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
136 <td>Private method to load the translation file.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
137 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
138 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
139 <td><a href="#RadonMetricsPlugin.__projectBrowserCyclomaticComplexity">__projectBrowserCyclomaticComplexity</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
140 <td>Private method to handle the cyclomatic complexity context menu action of the project sources browser.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
141 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
142 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
143 <td><a href="#RadonMetricsPlugin.__projectBrowserMaintainabilityIndex">__projectBrowserMaintainabilityIndex</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
144 <td>Private method to handle the maintainability index context menu action of the project sources browser.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
145 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
146 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
147 <td><a href="#RadonMetricsPlugin.__projectBrowserRawMetrics">__projectBrowserRawMetrics</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
148 <td>Private method to handle the code metrics context menu action of the project sources browser.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
149 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
150 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
151 <td><a href="#RadonMetricsPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
152 <td>Private slot called, when the the project browser context menu or a submenu is about to be shown.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
153 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
154 <tr>
18
58ce8a433422 Fixed a few bugs and added an 'activated' action to the various result lists.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 14
diff changeset
155 <td><a href="#RadonMetricsPlugin.__projectClosed">__projectClosed</a></td>
58ce8a433422 Fixed a few bugs and added an 'activated' action to the various result lists.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 14
diff changeset
156 <td>Private slot to handle closing a project.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
157 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
158 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
159 <td><a href="#RadonMetricsPlugin.__projectCyclomaticComplexity">__projectCyclomaticComplexity</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
160 <td>Private slot used to calculate the cyclomatic complexity for the project.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
161 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
162 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
163 <td><a href="#RadonMetricsPlugin.__projectMaintainabilityIndex">__projectMaintainabilityIndex</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
164 <td>Private slot used to calculate the maintainability indexes for the project.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
165 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
166 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167 <td><a href="#RadonMetricsPlugin.__projectRawMetrics">__projectRawMetrics</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
168 <td>Private slot used to calculate raw code metrics for the project.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
169 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
170 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
171 <td><a href="#RadonMetricsPlugin.__projectShowMenu">__projectShowMenu</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
172 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
173 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
174 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
175 <td><a href="#RadonMetricsPlugin.__serviceError">__serviceError</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
176 <td>Private slot handling service errors.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
177 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
178 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
179 <td><a href="#RadonMetricsPlugin.__showRadonVersion">__showRadonVersion</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
180 <td>Private slot to show the version number of the used radon library.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
181 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
182 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
183 <td><a href="#RadonMetricsPlugin.activate">activate</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
184 <td>Public method to activate this plug-in.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
185 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
186 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
187 <td><a href="#RadonMetricsPlugin.batchJobDone">batchJobDone</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
188 <td>Public slot handling the completion of a batch job.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
189 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
190 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
191 <td><a href="#RadonMetricsPlugin.cancelComplexityBatch">cancelComplexityBatch</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
192 <td>Public method to cancel all batch jobs.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
193 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
194 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
195 <td><a href="#RadonMetricsPlugin.cancelMaintainabilityIndexBatch">cancelMaintainabilityIndexBatch</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
196 <td>Public method to cancel all batch jobs.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
197 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
198 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
199 <td><a href="#RadonMetricsPlugin.cancelRawMetricsBatch">cancelRawMetricsBatch</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
200 <td>Public method to cancel all batch jobs.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
201 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
202 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
203 <td><a href="#RadonMetricsPlugin.cyclomaticComplexity">cyclomaticComplexity</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
204 <td>Public method to prepare cyclomatic complexity calculation on one Python source file.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
205 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
206 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
207 <td><a href="#RadonMetricsPlugin.cyclomaticComplexityBatch">cyclomaticComplexityBatch</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
208 <td>Public method to prepare cyclomatic complexity calculation on multiple Python source files.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
209 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
210 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
211 <td><a href="#RadonMetricsPlugin.deactivate">deactivate</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
212 <td>Public method to deactivate this plug-in.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
213 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
214 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
215 <td><a href="#RadonMetricsPlugin.maintainabilityIndex">maintainabilityIndex</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
216 <td>Public method to prepare maintainability index calculation on one Python source file.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
217 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
218 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
219 <td><a href="#RadonMetricsPlugin.maintainabilityIndexBatch">maintainabilityIndexBatch</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
220 <td>Public method to prepare maintainability index calculation on multiple Python source files.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
221 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
222 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
223 <td><a href="#RadonMetricsPlugin.metricsCalculationDone">metricsCalculationDone</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
224 <td>Public slot to dispatch the result.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
225 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
226 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
227 <td><a href="#RadonMetricsPlugin.rawMetrics">rawMetrics</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
228 <td>Public method to prepare raw code metrics calculation on one Python source file.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
229 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
230 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
231 <td><a href="#RadonMetricsPlugin.rawMetricsBatch">rawMetricsBatch</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
232 <td>Public method to prepare raw code metrics calculation on multiple Python source files.</td>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
233 </tr>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
234 <tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
235 <td><a href="#RadonMetricsPlugin.serviceErrorPy3">serviceErrorPy3</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
236 <td>Public slot handling service errors for Python 3.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
237 </tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
238 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
239 <h3>Static Methods</h3>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
240
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
241 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
242 <tr><td>None</td></tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
243 </table>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
244
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
245 <a NAME="RadonMetricsPlugin.__init__" ID="RadonMetricsPlugin.__init__"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
246 <h4>RadonMetricsPlugin (Constructor)</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
247 <b>RadonMetricsPlugin</b>(<i>ui</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
248
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
249 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
250 Constructor
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
251 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
252 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
253
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
254 <dt><i>ui</i> (UI.UserInterface)</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
255 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
256 reference to the user interface object
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
257 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
258 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
259 <a NAME="RadonMetricsPlugin.__editorClosed" ID="RadonMetricsPlugin.__editorClosed"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
260 <h4>RadonMetricsPlugin.__editorClosed</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
261 <b>__editorClosed</b>(<i>editor</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
262
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
263 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
264 Private slot called, when an editor was closed.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
265 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
266 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
267
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
268 <dt><i>editor</i></dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
269 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
270 reference to the editor (QScintilla.Editor)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
271 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
272 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
273 <a NAME="RadonMetricsPlugin.__editorCyclomaticComplexity" ID="RadonMetricsPlugin.__editorCyclomaticComplexity"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
274 <h4>RadonMetricsPlugin.__editorCyclomaticComplexity</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
275 <b>__editorCyclomaticComplexity</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
276
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
277 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
278 Private slot to handle the cyclomatic complexity action of the editor
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
279 show menu.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
280 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
281 <a NAME="RadonMetricsPlugin.__editorMaintainabilityIndex" ID="RadonMetricsPlugin.__editorMaintainabilityIndex"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
282 <h4>RadonMetricsPlugin.__editorMaintainabilityIndex</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
283 <b>__editorMaintainabilityIndex</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
284
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
285 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
286 Private slot to handle the maintainability index action of the editor
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
287 show menu.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
288 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
289 <a NAME="RadonMetricsPlugin.__editorOpened" ID="RadonMetricsPlugin.__editorOpened"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
290 <h4>RadonMetricsPlugin.__editorOpened</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
291 <b>__editorOpened</b>(<i>editor</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
292
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
293 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
294 Private slot called, when a new editor was opened.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
295 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
296 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
297
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
298 <dt><i>editor</i> (QScintilla.Editor)</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
299 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
300 reference to the new editor
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
301 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
302 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
303 <a NAME="RadonMetricsPlugin.__editorRawMetrics" ID="RadonMetricsPlugin.__editorRawMetrics"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
304 <h4>RadonMetricsPlugin.__editorRawMetrics</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
305 <b>__editorRawMetrics</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
306
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
307 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
308 Private slot to handle the raw code metrics action of the editor show
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
309 menu.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
310 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
311 <a NAME="RadonMetricsPlugin.__editorRenamed" ID="RadonMetricsPlugin.__editorRenamed"></a>
55
755bc8e1485a Upgraded the embedded Radon library to version 2.4.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 18
diff changeset
312 <h4>RadonMetricsPlugin.__editorRenamed</h4>
755bc8e1485a Upgraded the embedded Radon library to version 2.4.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 18
diff changeset
313 <b>__editorRenamed</b>(<i>editor</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
314
55
755bc8e1485a Upgraded the embedded Radon library to version 2.4.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 18
diff changeset
315 <p>
755bc8e1485a Upgraded the embedded Radon library to version 2.4.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 18
diff changeset
316 Private slot called, when an editor was renamed.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
317 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
318 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
319
55
755bc8e1485a Upgraded the embedded Radon library to version 2.4.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 18
diff changeset
320 <dt><i>editor</i> (QScintilla.Editor)</dt>
755bc8e1485a Upgraded the embedded Radon library to version 2.4.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 18
diff changeset
321 <dd>
755bc8e1485a Upgraded the embedded Radon library to version 2.4.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 18
diff changeset
322 reference to the renamed editor
755bc8e1485a Upgraded the embedded Radon library to version 2.4.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 18
diff changeset
323 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
324 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
325 <a NAME="RadonMetricsPlugin.__editorShowMenu" ID="RadonMetricsPlugin.__editorShowMenu"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
326 <h4>RadonMetricsPlugin.__editorShowMenu</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
327 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
328
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
329 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
330 Private slot called, when the the editor context menu or a submenu is
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
331 about to be shown.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
332 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
333 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
334
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
335 <dt><i>menuName</i></dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
336 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
337 name of the menu to be shown (string)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
338 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
339 <dt><i>menu</i></dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
340 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
341 reference to the menu (QMenu)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
342 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
343 <dt><i>editor</i></dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
344 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
345 reference to the editor
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
346 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
347 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
348 <a NAME="RadonMetricsPlugin.__initialize" ID="RadonMetricsPlugin.__initialize"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
349 <h4>RadonMetricsPlugin.__initialize</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
350 <b>__initialize</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
351
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
352 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
353 Private slot to (re)initialize the plugin.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
354 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
355 <a NAME="RadonMetricsPlugin.__loadTranslator" ID="RadonMetricsPlugin.__loadTranslator"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
356 <h4>RadonMetricsPlugin.__loadTranslator</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
357 <b>__loadTranslator</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
358
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
359 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
360 Private method to load the translation file.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
361 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
362 <a NAME="RadonMetricsPlugin.__projectBrowserCyclomaticComplexity" ID="RadonMetricsPlugin.__projectBrowserCyclomaticComplexity"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
363 <h4>RadonMetricsPlugin.__projectBrowserCyclomaticComplexity</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
364 <b>__projectBrowserCyclomaticComplexity</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
365
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
366 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
367 Private method to handle the cyclomatic complexity context menu action
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
368 of the project sources browser.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
369 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
370 <a NAME="RadonMetricsPlugin.__projectBrowserMaintainabilityIndex" ID="RadonMetricsPlugin.__projectBrowserMaintainabilityIndex"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
371 <h4>RadonMetricsPlugin.__projectBrowserMaintainabilityIndex</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
372 <b>__projectBrowserMaintainabilityIndex</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
373
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
374 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
375 Private method to handle the maintainability index context menu action
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
376 of the project sources browser.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
377 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
378 <a NAME="RadonMetricsPlugin.__projectBrowserRawMetrics" ID="RadonMetricsPlugin.__projectBrowserRawMetrics"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
379 <h4>RadonMetricsPlugin.__projectBrowserRawMetrics</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
380 <b>__projectBrowserRawMetrics</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
381
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
382 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
383 Private method to handle the code metrics context menu action of the
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
384 project sources browser.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
385 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
386 <a NAME="RadonMetricsPlugin.__projectBrowserShowMenu" ID="RadonMetricsPlugin.__projectBrowserShowMenu"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
387 <h4>RadonMetricsPlugin.__projectBrowserShowMenu</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
388 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
389
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
390 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
391 Private slot called, when the the project browser context menu or a
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
392 submenu is about to be shown.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
393 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
394 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
395
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
396 <dt><i>menuName</i></dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
397 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
398 name of the menu to be shown (string)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
399 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
400 <dt><i>menu</i></dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
401 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
402 reference to the menu (QMenu)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
403 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
404 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
405 <a NAME="RadonMetricsPlugin.__projectClosed" ID="RadonMetricsPlugin.__projectClosed"></a>
18
58ce8a433422 Fixed a few bugs and added an 'activated' action to the various result lists.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 14
diff changeset
406 <h4>RadonMetricsPlugin.__projectClosed</h4>
58ce8a433422 Fixed a few bugs and added an 'activated' action to the various result lists.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 14
diff changeset
407 <b>__projectClosed</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
408
18
58ce8a433422 Fixed a few bugs and added an 'activated' action to the various result lists.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 14
diff changeset
409 <p>
58ce8a433422 Fixed a few bugs and added an 'activated' action to the various result lists.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 14
diff changeset
410 Private slot to handle closing a project.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
411 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
412 <a NAME="RadonMetricsPlugin.__projectCyclomaticComplexity" ID="RadonMetricsPlugin.__projectCyclomaticComplexity"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
413 <h4>RadonMetricsPlugin.__projectCyclomaticComplexity</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
414 <b>__projectCyclomaticComplexity</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
415
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
416 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
417 Private slot used to calculate the cyclomatic complexity for the
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
418 project.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
419 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
420 <a NAME="RadonMetricsPlugin.__projectMaintainabilityIndex" ID="RadonMetricsPlugin.__projectMaintainabilityIndex"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
421 <h4>RadonMetricsPlugin.__projectMaintainabilityIndex</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
422 <b>__projectMaintainabilityIndex</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
423
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
424 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
425 Private slot used to calculate the maintainability indexes for the
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
426 project.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
427 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
428 <a NAME="RadonMetricsPlugin.__projectRawMetrics" ID="RadonMetricsPlugin.__projectRawMetrics"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
429 <h4>RadonMetricsPlugin.__projectRawMetrics</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
430 <b>__projectRawMetrics</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
431
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
432 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
433 Private slot used to calculate raw code metrics for the project.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
434 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
435 <a NAME="RadonMetricsPlugin.__projectShowMenu" ID="RadonMetricsPlugin.__projectShowMenu"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
436 <h4>RadonMetricsPlugin.__projectShowMenu</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
437 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
438
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
439 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
440 Private slot called, when the the project menu or a submenu is
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
441 about to be shown.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
442 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
443 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
444
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
445 <dt><i>menuName</i> (str)</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
446 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
447 name of the menu to be shown
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
448 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
449 <dt><i>menu</i> (QMenu)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
450 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
451 reference to the menu
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
452 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
453 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
454 <a NAME="RadonMetricsPlugin.__serviceError" ID="RadonMetricsPlugin.__serviceError"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
455 <h4>RadonMetricsPlugin.__serviceError</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
456 <b>__serviceError</b>(<i>type_, fn, msg</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
457
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
458 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
459 Private slot handling service errors.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
460 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
461 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
462
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
463 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
464 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
465 type of the calculated metrics
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
466 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
467 <dt><i>fn</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
468 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
469 file name
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
470 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
471 <dt><i>msg</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
472 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
473 message text
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
474 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
475 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
476 <a NAME="RadonMetricsPlugin.__showRadonVersion" ID="RadonMetricsPlugin.__showRadonVersion"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
477 <h4>RadonMetricsPlugin.__showRadonVersion</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
478 <b>__showRadonVersion</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
479
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
480 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
481 Private slot to show the version number of the used radon library.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
482 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
483 <a NAME="RadonMetricsPlugin.activate" ID="RadonMetricsPlugin.activate"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
484 <h4>RadonMetricsPlugin.activate</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
485 <b>activate</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
486
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
487 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
488 Public method to activate this plug-in.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
489 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
490 <dl>
78
4ce16e1d29f3 Prepared new release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 69
diff changeset
491 <dt>Return:</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
492 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
493 tuple of None and activation status
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
494 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
495 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
496 <dl>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
497 <dt>Return Type:</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
498 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
499 (None, bool)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
500 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
501 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
502 <a NAME="RadonMetricsPlugin.batchJobDone" ID="RadonMetricsPlugin.batchJobDone"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
503 <h4>RadonMetricsPlugin.batchJobDone</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
504 <b>batchJobDone</b>(<i>type_, fx, lang</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
505
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
506 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
507 Public slot handling the completion of a batch job.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
508 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
509 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
510
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
511 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
512 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
513 type of the calculated metrics
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
514 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
515 <dt><i>fx</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
516 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
517 service name
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
518 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
519 <dt><i>lang</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
520 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
521 language
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
522 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
523 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
524 <a NAME="RadonMetricsPlugin.cancelComplexityBatch" ID="RadonMetricsPlugin.cancelComplexityBatch"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
525 <h4>RadonMetricsPlugin.cancelComplexityBatch</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
526 <b>cancelComplexityBatch</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
527
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
528 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
529 Public method to cancel all batch jobs.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
530 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
531 <a NAME="RadonMetricsPlugin.cancelMaintainabilityIndexBatch" ID="RadonMetricsPlugin.cancelMaintainabilityIndexBatch"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
532 <h4>RadonMetricsPlugin.cancelMaintainabilityIndexBatch</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
533 <b>cancelMaintainabilityIndexBatch</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
534
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
535 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
536 Public method to cancel all batch jobs.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
537 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
538 <a NAME="RadonMetricsPlugin.cancelRawMetricsBatch" ID="RadonMetricsPlugin.cancelRawMetricsBatch"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
539 <h4>RadonMetricsPlugin.cancelRawMetricsBatch</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
540 <b>cancelRawMetricsBatch</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
541
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
542 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
543 Public method to cancel all batch jobs.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
544 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
545 <a NAME="RadonMetricsPlugin.cyclomaticComplexity" ID="RadonMetricsPlugin.cyclomaticComplexity"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
546 <h4>RadonMetricsPlugin.cyclomaticComplexity</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
547 <b>cyclomaticComplexity</b>(<i>lang, filename, source</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
548
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
549 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
550 Public method to prepare cyclomatic complexity calculation on one
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
551 Python source file.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
552 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
553 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
554
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
555 <dt><i>lang</i> (str or None)</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
556 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
557 language of the file or None to determine by internal
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
558 algorithm
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
559 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
560 <dt><i>filename</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
561 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
562 source filename
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
563 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
564 <dt><i>source</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
565 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
566 string containing the code
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
567 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
568 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
569 <a NAME="RadonMetricsPlugin.cyclomaticComplexityBatch" ID="RadonMetricsPlugin.cyclomaticComplexityBatch"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
570 <h4>RadonMetricsPlugin.cyclomaticComplexityBatch</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
571 <b>cyclomaticComplexityBatch</b>(<i>argumentsList</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
572
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
573 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
574 Public method to prepare cyclomatic complexity calculation on multiple
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
575 Python source files.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
576 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
577 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
578
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
579 <dt><i>argumentsList</i> ((str, str))</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
580 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
581 list of arguments tuples with each tuple
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
582 containing filename and source
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
583 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
584 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
585 <a NAME="RadonMetricsPlugin.deactivate" ID="RadonMetricsPlugin.deactivate"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
586 <h4>RadonMetricsPlugin.deactivate</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
587 <b>deactivate</b>(<i></i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
588
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
589 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
590 Public method to deactivate this plug-in.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
591 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
592 <a NAME="RadonMetricsPlugin.maintainabilityIndex" ID="RadonMetricsPlugin.maintainabilityIndex"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
593 <h4>RadonMetricsPlugin.maintainabilityIndex</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
594 <b>maintainabilityIndex</b>(<i>lang, filename, source</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
595
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
596 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
597 Public method to prepare maintainability index calculation on one
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
598 Python source file.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
599 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
600 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
601
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
602 <dt><i>lang</i> (str or None)</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
603 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
604 language of the file or None to determine by internal
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
605 algorithm
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
606 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
607 <dt><i>filename</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
608 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
609 source filename
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
610 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
611 <dt><i>source</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
612 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
613 string containing the code
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
614 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
615 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
616 <a NAME="RadonMetricsPlugin.maintainabilityIndexBatch" ID="RadonMetricsPlugin.maintainabilityIndexBatch"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
617 <h4>RadonMetricsPlugin.maintainabilityIndexBatch</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
618 <b>maintainabilityIndexBatch</b>(<i>argumentsList</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
619
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
620 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
621 Public method to prepare maintainability index calculation on multiple
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
622 Python source files.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
623 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
624 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
625
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
626 <dt><i>argumentsList</i> ((str, str))</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
627 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
628 list of arguments tuples with each tuple
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
629 containing filename and source
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
630 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
631 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
632 <a NAME="RadonMetricsPlugin.metricsCalculationDone" ID="RadonMetricsPlugin.metricsCalculationDone"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
633 <h4>RadonMetricsPlugin.metricsCalculationDone</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
634 <b>metricsCalculationDone</b>(<i>type_, filename, result</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
635
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
636 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
637 Public slot to dispatch the result.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
638 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
639 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
640
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
641 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
642 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
643 type of the calculated metrics
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
644 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
645 <dt><i>filename</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
646 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
647 name of the file the results belong to
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
648 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
649 <dt><i>result</i> (dict)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
650 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
651 result dictionary
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
652 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
653 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
654 <a NAME="RadonMetricsPlugin.rawMetrics" ID="RadonMetricsPlugin.rawMetrics"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
655 <h4>RadonMetricsPlugin.rawMetrics</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
656 <b>rawMetrics</b>(<i>lang, filename, source</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
657
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
658 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
659 Public method to prepare raw code metrics calculation on one Python
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
660 source file.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
661 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
662 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
663
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
664 <dt><i>lang</i> (str or None)</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
665 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
666 language of the file or None to determine by internal
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
667 algorithm
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
668 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
669 <dt><i>filename</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
670 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
671 source filename
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
672 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
673 <dt><i>source</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
674 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
675 string containing the code
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
676 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
677 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
678 <a NAME="RadonMetricsPlugin.rawMetricsBatch" ID="RadonMetricsPlugin.rawMetricsBatch"></a>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
679 <h4>RadonMetricsPlugin.rawMetricsBatch</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
680 <b>rawMetricsBatch</b>(<i>argumentsList</i>)
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
681
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
682 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
683 Public method to prepare raw code metrics calculation on multiple
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
684 Python source files.
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
685 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
686 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
687
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
688 <dt><i>argumentsList</i> ((str, str))</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
689 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
690 list of arguments tuples with each tuple
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
691 containing filename and source
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
692 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
693 </dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
694 <a NAME="RadonMetricsPlugin.serviceErrorPy3" ID="RadonMetricsPlugin.serviceErrorPy3"></a>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
695 <h4>RadonMetricsPlugin.serviceErrorPy3</h4>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
696 <b>serviceErrorPy3</b>(<i>type_, fx, lang, fn, msg</i>)
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
697
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
698 <p>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
699 Public slot handling service errors for Python 3.
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
700 </p>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
701 <dl>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
702
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
703 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
704 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
705 type of the calculated metrics
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
706 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
707 <dt><i>fx</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
708 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
709 service name
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
710 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
711 <dt><i>lang</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
712 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
713 language
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
714 </dd>
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
715 <dt><i>fn</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
716 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
717 file name
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
718 </dd>
69
cdf51e6abaee Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 55
diff changeset
719 <dt><i>msg</i> (str)</dt>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
720 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
721 message text
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
722 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
723 </dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
724 <div align="right"><a href="#top">Up</a></div>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
725 <hr />
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
726 </body></html>

eric ide

mercurial