RadonMetrics/Documentation/source/Plugin_Metrics_Radon.PluginMetricsRadon.html

Sun, 04 Oct 2015 12:55:24 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 04 Oct 2015 12:55:24 +0200
changeset 31
fe59ed68bd19
parent 18
58ce8a433422
child 55
755bc8e1485a
permissions
-rw-r--r--

Fixed some source code docu issues.

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>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body><a NAME="top" ID="top"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>Plugin_Metrics_Radon.PluginMetricsRadon</h1>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 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
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 <h3>Global Attributes</h3>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <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>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <h3>Classes</h3>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <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
34 <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
35 </tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <h3>Functions</h3>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <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
40 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <hr /><hr />
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <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
43 <h2>RadonMetricsPlugin</h2>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 Class 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
46 </p><h3>Signals</h3>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <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
49 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 emitted when a code metrics batch is done
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 </dd><dt>complexityDone(str, dict)</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 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
54 cyclomatic complexity was 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
55 </dd><dt>error(str, 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
56 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 emitted in case of an error
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 </dd><dt>maintainabilityIndexDone(str, dict)</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 the
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 maintainability index was 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
62 </dd><dt>metricsDone(str, dict)</dt>
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 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
65 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
66 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 </dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <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
69 QObject
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <h3>Class Attributes</h3>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <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
73 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <h3>Class Methods</h3>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <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
77 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <h3>Methods</h3>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <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
82 <td>Constructor</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <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
85 <td>Private slot called, when an editor was closed.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <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
88 <td>Private slot to handle the cyclomatic complexity action of the editor show menu.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <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
91 <td>Private slot to handle the maintainability index action of the editor show menu.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 <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
94 <td>Private slot called, when a new editor was opened.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <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
97 <td>Private slot to handle the raw code metrics action of the editor show menu.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 </tr><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.__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
100 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <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
103 <td>Private slot to (re)initialize the plugin.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <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
106 <td>Private method to load the translation file.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <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
109 <td>Private method to handle the cyclomatic complexity context menu action of the project sources browser.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 </tr><tr>
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.__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
112 <td>Private method to handle the maintainability index context menu action of the project sources browser.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 <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
115 <td>Private method to handle the code metrics context menu action of the project sources browser.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <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
118 <td>Private slot called, when the the project browser context menu or a submenu is about to be shown.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 </tr><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
120 <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
121 <td>Private slot to handle closing a project.</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
122 </tr><tr>
14
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 <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
124 <td>Private slot used to calculate the cyclomatic complexity for the project.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 <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
127 <td>Private slot used to calculate the maintainability indexes for the project.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
129 <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
130 <td>Private slot used to calculate raw code metrics for the project.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 <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
133 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
134 </tr><tr>
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.__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
136 <td>Private slot handling service errors.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
137 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
138 <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
139 <td>Private slot to show the version number of the used radon library.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
140 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
141 <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
142 <td>Public method to activate this 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
143 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
144 <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
145 <td>Public slot handling the completion of a batch job.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
146 </tr><tr>
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.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
148 <td>Public method to cancel all batch jobs.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
149 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
150 <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
151 <td>Public method to cancel all batch jobs.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
152 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
153 <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
154 <td>Public method to cancel all batch jobs.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
155 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
156 <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
157 <td>Public method to prepare cyclomatic complexity calculation on one Python source file.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
158 </tr><tr>
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.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
160 <td>Public method to prepare cyclomatic complexity calculation on multiple Python source files.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
161 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
162 <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
163 <td>Public method to deactivate this 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
164 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
165 <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
166 <td>Public method to prepare maintainability index calculation on one Python source file.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
168 <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
169 <td>Public method to prepare maintainability index calculation on multiple Python source files.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
170 </tr><tr>
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.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
172 <td>Public slot to dispatch the result.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
173 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
174 <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
175 <td>Public method to prepare raw code metrics calculation on one Python source file.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
176 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
177 <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
178 <td>Public method to prepare raw code metrics calculation on multiple Python source files.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
179 </tr><tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
180 <td><a href="#RadonMetricsPlugin.serviceErrorPy2">serviceErrorPy2</a></td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
181 <td>Public slot handling service errors for Python 2.</td>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
182 </tr><tr>
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.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
184 <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
185 </tr>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
186 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
187 <h3>Static Methods</h3>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
188 <table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
189 <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
190 </table>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
191 <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
192 <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
193 <b>RadonMetricsPlugin</b>(<i>ui</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
194 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
195 Constructor
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
196 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
197 <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
198 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
199 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
200 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
201 </dl><a NAME="RadonMetricsPlugin.__editorClosed" ID="RadonMetricsPlugin.__editorClosed"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
202 <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
203 <b>__editorClosed</b>(<i>editor</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
204 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
205 Private slot called, when an editor was closed.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
206 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
207 <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
208 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
209 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
210 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
211 </dl><a NAME="RadonMetricsPlugin.__editorCyclomaticComplexity" ID="RadonMetricsPlugin.__editorCyclomaticComplexity"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
212 <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
213 <b>__editorCyclomaticComplexity</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
214 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
215 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
216 show menu.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
217 </p><a NAME="RadonMetricsPlugin.__editorMaintainabilityIndex" ID="RadonMetricsPlugin.__editorMaintainabilityIndex"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
218 <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
219 <b>__editorMaintainabilityIndex</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
220 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
221 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
222 show menu.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
223 </p><a NAME="RadonMetricsPlugin.__editorOpened" ID="RadonMetricsPlugin.__editorOpened"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
224 <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
225 <b>__editorOpened</b>(<i>editor</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
226 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
227 Private slot called, when a new editor was opened.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
228 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
229 <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
230 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
231 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
232 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
233 </dl><a NAME="RadonMetricsPlugin.__editorRawMetrics" ID="RadonMetricsPlugin.__editorRawMetrics"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
234 <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
235 <b>__editorRawMetrics</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
236 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
237 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
238 menu.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
239 </p><a NAME="RadonMetricsPlugin.__editorShowMenu" ID="RadonMetricsPlugin.__editorShowMenu"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
240 <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
241 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
242 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
243 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
244 about to be shown.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
245 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
246 <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
247 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
248 name of the menu to be shown (string)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
249 </dd><dt><i>menu</i></dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
250 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
251 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
252 </dd><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
253 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
254 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
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 </dl><a NAME="RadonMetricsPlugin.__initialize" ID="RadonMetricsPlugin.__initialize"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
257 <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
258 <b>__initialize</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
259 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
260 Private slot to (re)initialize the plugin.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
261 </p><a NAME="RadonMetricsPlugin.__loadTranslator" ID="RadonMetricsPlugin.__loadTranslator"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
262 <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
263 <b>__loadTranslator</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
264 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
265 Private method to load the translation file.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
266 </p><a NAME="RadonMetricsPlugin.__projectBrowserCyclomaticComplexity" ID="RadonMetricsPlugin.__projectBrowserCyclomaticComplexity"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
267 <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
268 <b>__projectBrowserCyclomaticComplexity</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
269 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
270 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
271 of the project sources browser.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
272 </p><a NAME="RadonMetricsPlugin.__projectBrowserMaintainabilityIndex" ID="RadonMetricsPlugin.__projectBrowserMaintainabilityIndex"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
273 <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
274 <b>__projectBrowserMaintainabilityIndex</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
275 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
276 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
277 of the project sources browser.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
278 </p><a NAME="RadonMetricsPlugin.__projectBrowserRawMetrics" ID="RadonMetricsPlugin.__projectBrowserRawMetrics"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
279 <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
280 <b>__projectBrowserRawMetrics</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
281 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
282 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
283 project sources browser.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
284 </p><a NAME="RadonMetricsPlugin.__projectBrowserShowMenu" ID="RadonMetricsPlugin.__projectBrowserShowMenu"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
285 <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
286 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
287 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
288 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
289 submenu is about to be shown.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
290 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
291 <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
292 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
293 name of the menu to be shown (string)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
294 </dd><dt><i>menu</i></dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
295 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
296 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
297 </dd>
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
298 </dl><a NAME="RadonMetricsPlugin.__projectClosed" ID="RadonMetricsPlugin.__projectClosed"></a>
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
299 <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
300 <b>__projectClosed</b>(<i></i>)
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
301 <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
302 Private slot to handle closing a project.
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
303 </p><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
304 <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
305 <b>__projectCyclomaticComplexity</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
306 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
307 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
308 project.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
309 </p><a NAME="RadonMetricsPlugin.__projectMaintainabilityIndex" ID="RadonMetricsPlugin.__projectMaintainabilityIndex"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
310 <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
311 <b>__projectMaintainabilityIndex</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
312 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
313 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
314 project.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
315 </p><a NAME="RadonMetricsPlugin.__projectRawMetrics" ID="RadonMetricsPlugin.__projectRawMetrics"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
316 <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
317 <b>__projectRawMetrics</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
318 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
319 Private slot used to calculate raw code metrics for the project.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
320 </p><a NAME="RadonMetricsPlugin.__projectShowMenu" ID="RadonMetricsPlugin.__projectShowMenu"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
321 <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
322 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
323 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
324 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
325 about to be shown.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
326 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
327 <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
328 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
329 name of the menu to be shown
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
330 </dd><dt><i>menu</i> (QMenu)</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
331 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
332 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
333 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
334 </dl><a NAME="RadonMetricsPlugin.__serviceError" ID="RadonMetricsPlugin.__serviceError"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
335 <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
336 <b>__serviceError</b>(<i>type_, fn, msg</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
337 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
338 Private slot handling service errors.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
339 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
340 <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
341 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
342 type of the calculated metrics
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
343 </dd><dt><i>fn</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
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 file name
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
346 </dd><dt><i>msg</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
347 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
348 message text
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
349 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
350 </dl><a NAME="RadonMetricsPlugin.__showRadonVersion" ID="RadonMetricsPlugin.__showRadonVersion"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
351 <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
352 <b>__showRadonVersion</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
353 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
354 Private slot to show the version number of the used radon library.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
355 </p><a NAME="RadonMetricsPlugin.activate" ID="RadonMetricsPlugin.activate"></a>
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.activate</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>activate</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
358 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
359 Public method to activate this plug-in.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
360 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
361 <dt>Returns:</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
362 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
363 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
364 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
365 </dl><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
366 <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
367 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
368 (None, bool)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
369 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
370 </dl><a NAME="RadonMetricsPlugin.batchJobDone" ID="RadonMetricsPlugin.batchJobDone"></a>
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.batchJobDone</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>batchJobDone</b>(<i>type_, fx, lang</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
373 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
374 Public slot handling the completion of a batch job.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
375 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
376 <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
377 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
378 type of the calculated metrics
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
379 </dd><dt><i>fx</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
380 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
381 service name
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
382 </dd><dt><i>lang</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
383 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
384 language
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
385 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
386 </dl><a NAME="RadonMetricsPlugin.cancelComplexityBatch" ID="RadonMetricsPlugin.cancelComplexityBatch"></a>
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.cancelComplexityBatch</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>cancelComplexityBatch</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
389 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
390 Public method to cancel all batch jobs.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
391 </p><a NAME="RadonMetricsPlugin.cancelMaintainabilityIndexBatch" ID="RadonMetricsPlugin.cancelMaintainabilityIndexBatch"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
392 <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
393 <b>cancelMaintainabilityIndexBatch</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
394 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
395 Public method to cancel all batch jobs.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
396 </p><a NAME="RadonMetricsPlugin.cancelRawMetricsBatch" ID="RadonMetricsPlugin.cancelRawMetricsBatch"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
397 <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
398 <b>cancelRawMetricsBatch</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
399 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
400 Public method to cancel all batch jobs.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
401 </p><a NAME="RadonMetricsPlugin.cyclomaticComplexity" ID="RadonMetricsPlugin.cyclomaticComplexity"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
402 <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
403 <b>cyclomaticComplexity</b>(<i>lang, filename, source</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
404 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
405 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
406 Python source file.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
407 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
408 <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
409 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
410 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
411 algorithm
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
412 </dd><dt><i>filename</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
413 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
414 source filename
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
415 </dd><dt><i>source</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
416 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
417 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
418 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
419 </dl><a NAME="RadonMetricsPlugin.cyclomaticComplexityBatch" ID="RadonMetricsPlugin.cyclomaticComplexityBatch"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
420 <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
421 <b>cyclomaticComplexityBatch</b>(<i>argumentsList</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
422 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
423 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
424 Python source files.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
425 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
426 <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
427 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
428 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
429 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
430 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
431 </dl><a NAME="RadonMetricsPlugin.deactivate" ID="RadonMetricsPlugin.deactivate"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
432 <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
433 <b>deactivate</b>(<i></i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
434 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
435 Public method to deactivate this plug-in.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
436 </p><a NAME="RadonMetricsPlugin.maintainabilityIndex" ID="RadonMetricsPlugin.maintainabilityIndex"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
437 <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
438 <b>maintainabilityIndex</b>(<i>lang, filename, source</i>)
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 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
441 Python source file.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
442 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
443 <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
444 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
445 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
446 algorithm
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
447 </dd><dt><i>filename</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
448 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
449 source filename
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
450 </dd><dt><i>source</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
451 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
452 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
453 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
454 </dl><a NAME="RadonMetricsPlugin.maintainabilityIndexBatch" ID="RadonMetricsPlugin.maintainabilityIndexBatch"></a>
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.maintainabilityIndexBatch</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>maintainabilityIndexBatch</b>(<i>argumentsList</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
457 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
458 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
459 Python source files.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
460 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
461 <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
462 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
463 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
464 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
465 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
466 </dl><a NAME="RadonMetricsPlugin.metricsCalculationDone" ID="RadonMetricsPlugin.metricsCalculationDone"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
467 <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
468 <b>metricsCalculationDone</b>(<i>type_, filename, result</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
469 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
470 Public slot to dispatch the result.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
471 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
472 <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
473 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
474 type of the calculated metrics
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
475 </dd><dt><i>filename</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
476 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
477 name of the file the results belong to
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
478 </dd><dt><i>result</i> (dict)</dt>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
479 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
480 result dictionary
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
481 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
482 </dl><a NAME="RadonMetricsPlugin.rawMetrics" ID="RadonMetricsPlugin.rawMetrics"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
483 <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
484 <b>rawMetrics</b>(<i>lang, filename, source</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
485 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
486 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
487 source file.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
488 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
489 <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
490 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
491 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
492 algorithm
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
493 </dd><dt><i>filename</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
494 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
495 source filename
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
496 </dd><dt><i>source</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
497 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
498 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
499 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
500 </dl><a NAME="RadonMetricsPlugin.rawMetricsBatch" ID="RadonMetricsPlugin.rawMetricsBatch"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
501 <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
502 <b>rawMetricsBatch</b>(<i>argumentsList</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
503 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
504 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
505 Python source files.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
506 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
507 <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
508 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
509 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
510 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
511 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
512 </dl><a NAME="RadonMetricsPlugin.serviceErrorPy2" ID="RadonMetricsPlugin.serviceErrorPy2"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
513 <h4>RadonMetricsPlugin.serviceErrorPy2</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
514 <b>serviceErrorPy2</b>(<i>type_, fx, lang, fn, msg</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
515 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
516 Public slot handling service errors for Python 2.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
517 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
518 <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
519 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
520 type of the calculated metrics
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
521 </dd><dt><i>fx</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
522 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
523 service name
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
524 </dd><dt><i>lang</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
525 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
526 language
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
527 </dd><dt><i>fn</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
528 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
529 file name
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
530 </dd><dt><i>msg</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
531 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
532 message text
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
533 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
534 </dl><a NAME="RadonMetricsPlugin.serviceErrorPy3" ID="RadonMetricsPlugin.serviceErrorPy3"></a>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
535 <h4>RadonMetricsPlugin.serviceErrorPy3</h4>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
536 <b>serviceErrorPy3</b>(<i>type_, fx, lang, fn, msg</i>)
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
537 <p>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
538 Public slot handling service errors for Python 3.
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
539 </p><dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
540 <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
541 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
542 type of the calculated metrics
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
543 </dd><dt><i>fx</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
544 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
545 service name
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
546 </dd><dt><i>lang</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
547 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
548 language
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
549 </dd><dt><i>fn</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
550 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
551 file name
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
552 </dd><dt><i>msg</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
553 <dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
554 message text
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
555 </dd>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
556 </dl>
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
557 <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
558 <hr />
5f206edea27e Completed the first version by generating documentation, translations and the packaging stuff.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
559 </body></html>

eric ide

mercurial