Fixed some source code docu issues.

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 30
37318556a70f
child 32
f8d1858fdb52

Fixed some source code docu issues.

RadonMetrics/CyclomaticComplexityDialog.py file | annotate | diff | comparison | revisions
RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityDialog.html file | annotate | diff | comparison | revisions
RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexDialog.html file | annotate | diff | comparison | revisions
RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.RawMetricsDialog.html file | annotate | diff | comparison | revisions
RadonMetrics/MaintainabilityIndexDialog.py file | annotate | diff | comparison | revisions
RadonMetrics/RawMetricsDialog.py file | annotate | diff | comparison | revisions
--- a/RadonMetrics/CyclomaticComplexityDialog.py	Sun Sep 27 16:44:44 2015 +0200
+++ b/RadonMetrics/CyclomaticComplexityDialog.py	Sun Oct 04 12:55:24 2015 +0200
@@ -596,6 +596,11 @@
     def on_resultList_itemActivated(self, item, column):
         """
         Private slot to handle the activation of a result item.
+        
+        @param item reference to the activated item
+        @type QTreeWidgetItem
+        @param column activated column
+        @type int
         """
         filename = item.data(0, self.FilePathRole)
         lineno = item.data(0, self.LineNumberRole)
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityDialog.html	Sun Sep 27 16:44:44 2015 +0200
+++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityDialog.html	Sun Oct 04 12:55:24 2015 +0200
@@ -293,7 +293,15 @@
 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
 <p>
         Private slot to handle the activation of a result item.
-</p><a NAME="CyclomaticComplexityDialog.on_startButton_clicked" ID="CyclomaticComplexityDialog.on_startButton_clicked"></a>
+</p><dl>
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the activated item
+</dd><dt><i>column</i> (int)</dt>
+<dd>
+activated column
+</dd>
+</dl><a NAME="CyclomaticComplexityDialog.on_startButton_clicked" ID="CyclomaticComplexityDialog.on_startButton_clicked"></a>
 <h4>CyclomaticComplexityDialog.on_startButton_clicked</h4>
 <b>on_startButton_clicked</b>(<i></i>)
 <p>
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexDialog.html	Sun Sep 27 16:44:44 2015 +0200
+++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexDialog.html	Sun Oct 04 12:55:24 2015 +0200
@@ -239,7 +239,15 @@
 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
 <p>
         Private slot to handle the activation of a result item.
-</p><a NAME="MaintainabilityIndexDialog.on_startButton_clicked" ID="MaintainabilityIndexDialog.on_startButton_clicked"></a>
+</p><dl>
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the activated item
+</dd><dt><i>column</i> (int)</dt>
+<dd>
+activated column
+</dd>
+</dl><a NAME="MaintainabilityIndexDialog.on_startButton_clicked" ID="MaintainabilityIndexDialog.on_startButton_clicked"></a>
 <h4>MaintainabilityIndexDialog.on_startButton_clicked</h4>
 <b>on_startButton_clicked</b>(<i></i>)
 <p>
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.RawMetricsDialog.html	Sun Sep 27 16:44:44 2015 +0200
+++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.RawMetricsDialog.html	Sun Oct 04 12:55:24 2015 +0200
@@ -266,7 +266,15 @@
 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
 <p>
         Private slot to handle the activation of a result item.
-</p><a NAME="RawMetricsDialog.on_startButton_clicked" ID="RawMetricsDialog.on_startButton_clicked"></a>
+</p><dl>
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the activated item
+</dd><dt><i>column</i> (int)</dt>
+<dd>
+activated column
+</dd>
+</dl><a NAME="RawMetricsDialog.on_startButton_clicked" ID="RawMetricsDialog.on_startButton_clicked"></a>
 <h4>RawMetricsDialog.on_startButton_clicked</h4>
 <b>on_startButton_clicked</b>(<i></i>)
 <p>
--- a/RadonMetrics/MaintainabilityIndexDialog.py	Sun Sep 27 16:44:44 2015 +0200
+++ b/RadonMetrics/MaintainabilityIndexDialog.py	Sun Oct 04 12:55:24 2015 +0200
@@ -448,6 +448,11 @@
     def on_resultList_itemActivated(self, item, column):
         """
         Private slot to handle the activation of a result item.
+        
+        @param item reference to the activated item
+        @type QTreeWidgetItem
+        @param column activated column
+        @type int
         """
         filename = item.data(0, self.FilePathRole)
         if filename:
--- a/RadonMetrics/RawMetricsDialog.py	Sun Sep 27 16:44:44 2015 +0200
+++ b/RadonMetrics/RawMetricsDialog.py	Sun Oct 04 12:55:24 2015 +0200
@@ -501,6 +501,11 @@
     def on_resultList_itemActivated(self, item, column):
         """
         Private slot to handle the activation of a result item.
+        
+        @param item reference to the activated item
+        @type QTreeWidgetItem
+        @param column activated column
+        @type int
         """
         filename = item.data(0, self.FilePathRole)
         if filename:

eric ide

mercurial