src/eric7/DataViews/CodeMetricsDialog.py

branch
eric7
changeset 10423
299802979277
parent 10076
649f7ca537ea
child 10439
21c28b0f9e41
--- a/src/eric7/DataViews/CodeMetricsDialog.py	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/DataViews/CodeMetricsDialog.py	Tue Dec 19 19:57:08 2023 +0100
@@ -38,7 +38,8 @@
         """
         Constructor
 
-        @param parent parent widget (QWidget)
+        @param parent parent widget
+        @type QWidget
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -76,9 +77,12 @@
         """
         Private slot to create a new item in the result list.
 
-        @param parent parent of the new item (QTreeWidget or QTreeWidgetItem)
-        @param values values to be displayed (list)
+        @param parent parent of the new item
+        @type QTreeWidget or QTreeWidgetItem
+        @param values values to be displayed
+        @type list of int
         @return the generated item
+        @rtype QTreeWidgetItem
         """
         data = [values[0]]
         for value in values[1:]:
@@ -104,8 +108,10 @@
         """
         Private slot to create a new item in the summary list.
 
-        @param col0 string for column 0 (string)
-        @param col1 string for column 1 (string)
+        @param col0 string for column 0
+        @type str
+        @param col1 string for column 1
+        @type str
         """
         itm = QTreeWidgetItem(self.summaryList, [col0, col1])
         itm.setTextAlignment(1, Qt.AlignmentFlag.AlignRight)
@@ -135,7 +141,8 @@
         Public slot to start the code metrics determination.
 
         @param fn file or list of files or directory to show
-                the code metrics for (string or list of strings)
+                the code metrics for
+        @type str or list of str
         """
         self.cancelled = False
         self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setEnabled(False)
@@ -219,10 +226,14 @@
         """
         Private method to extract the code metric values.
 
-        @param loc reference to the locale object (QLocale)
+        @param loc reference to the locale object
+        @type QLocale
         @param stats reference to the code metric statistics object
+        @type SourceStat
         @param identifier identifier to get values for
-        @return list of values suitable for display (list of strings)
+        @type str
+        @return list of values suitable for display
+        @rtype list of str
         """
         counters = stats.counters.get(identifier, {})
         v = []
@@ -264,7 +275,8 @@
         """
         Private slot called by a button of the button box clicked.
 
-        @param button button that was clicked (QAbstractButton)
+        @param button button that was clicked
+        @type QAbstractButton
         """
         if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close):
             self.close()
@@ -300,7 +312,8 @@
         """
         Private slot to show the context menu of the listview.
 
-        @param coord the position of the mouse pointer (QPoint)
+        @param coord the position of the mouse pointer
+        @type QPoint
         """
         if self.resultList.topLevelItemCount() > 0:
             self.__menu.popup(self.mapToGlobal(coord))

eric ide

mercurial