--- a/src/eric7/Debugger/WatchPointModel.py Sat Dec 16 17:52:02 2023 +0100
+++ b/src/eric7/Debugger/WatchPointModel.py Sun Dec 17 17:15:19 2023 +0100
@@ -54,7 +54,8 @@
"""
Constructor
- @param parent reference to the parent widget (QObject)
+ @param parent reference to the parent object
+ @type QObject
"""
super().__init__(parent)
@@ -64,8 +65,10 @@
"""
Public method to get the current column count.
- @param parent index of the parent item (QModelIndex) (Unused)
- @return column count (integer)
+ @param parent index of the parent item (unused)
+ @type QModelIndex
+ @return column count
+ @rtype int
"""
return len(WatchPointModel.Header)
@@ -73,8 +76,10 @@
"""
Public method to get the current row count.
- @param parent index of the parent item (QModelIndex)
- @return row count (integer)
+ @param parent index of the parent item
+ @type QModelIndex
+ @return row count
+ @rtype int
"""
# we do not have a tree, parent should always be invalid
if parent is None or not parent.isValid():
@@ -86,9 +91,12 @@
"""
Public method to get the requested data.
- @param index index of the requested data (QModelIndex)
- @param role role of the requested data (Qt.ItemDataRole)
+ @param index index of the requested data
+ @type QModelIndex
+ @param role role of the requested data
+ @type Qt.ItemDataRole
@return the requested data
+ @rtype Any
"""
if not index.isValid():
return None
@@ -126,8 +134,10 @@
"""
Public method to get item flags.
- @param index index of the requested flags (QModelIndex)
- @return item flags for the given index (Qt.ItemFlags)
+ @param index index of the requested flags
+ @type QModelIndex
+ @return item flags for the given index
+ @rtype Qt.ItemFlags
"""
if not index.isValid():
return Qt.ItemFlag.ItemIsEnabled
@@ -138,10 +148,14 @@
"""
Public method to get header data.
- @param section section number of the requested header data (integer)
- @param orientation orientation of the header (Qt.Orientation)
- @param role role of the requested data (Qt.ItemDataRole)
+ @param section section number of the requested header data
+ @type int
+ @param orientation orientation of the header
+ @type Qt.Orientation
+ @param role role of the requested data
+ @type Qt.ItemDataRole
@return header data
+ @rtype Any
"""
if (
orientation == Qt.Orientation.Horizontal
@@ -158,10 +172,14 @@
"""
Public method to create an index.
- @param row row number for the index (integer)
- @param column column number for the index (integer)
- @param parent index of the parent item (QModelIndex)
- @return requested index (QModelIndex)
+ @param row row number for the index
+ @type int
+ @param column column number for the index
+ @type int
+ @param parent index of the parent item
+ @type QModelIndex
+ @return requested index
+ @rtype QModelIndex
"""
if (
(parent and parent.isValid())
@@ -178,8 +196,10 @@
"""
Public method to get the parent index.
- @param index index of item to get parent (QModelIndex)
- @return index of parent (QModelIndex)
+ @param index index of item to get parent
+ @type QModelIndex
+ @return index of parent
+ @rtype QModelIndex
"""
return QModelIndex()
@@ -187,8 +207,10 @@
"""
Public method to check for the presence of child items.
- @param parent index of parent item (QModelIndex)
- @return flag indicating the presence of child items (boolean)
+ @param parent index of parent item
+ @type QModelIndex
+ @return flag indicating the presence of child items
+ @rtype bool
"""
if parent is None or not parent.isValid():
return len(self.watchpoints) > 0
@@ -232,12 +254,15 @@
"""
Public method to set the values of a watch expression given by index.
- @param index index of the watch expression (QModelIndex)
- @param cond expression of the watch expression (string)
- @param special special condition of the watch expression (string)
+ @param index index of the watch expression
+ @type QModelIndex
+ @param cond expression of the watch expression
+ @type str
+ @param special special condition of the watch expression
+ @type str
@param properties properties of the watch expression
- (tuple of temporary flag (bool), enabled flag (bool),
- ignore count (integer))
+ (tuple of temporary flag, enabled flag, ignore count)
+ @type tuple of (bool, bool, int)
"""
if index.isValid():
row = index.row()
@@ -254,8 +279,10 @@
Public method to set the enabled state of a watch expression given by
index.
- @param index index of the watch expression (QModelIndex)
- @param enabled flag giving the enabled state (boolean)
+ @param index index of the watch expression
+ @type QModelIndex
+ @param enabled flag giving the enabled state
+ @type bool
"""
if index.isValid():
row = index.row()
@@ -269,7 +296,8 @@
"""
Public method to set the values of a watch expression given by index.
- @param index index of the watch expression (QModelIndex)
+ @param index index of the watch expression
+ @type QModelIndex
"""
if index.isValid():
row = index.row()
@@ -282,7 +310,8 @@
Public method to delete a list of watch expressions given by their
indexes.
- @param idxList list of watch expression indexes (list of QModelIndex)
+ @param idxList list of watch expression indexes
+ @type list of QModelIndex
"""
rows = []
for index in idxList:
@@ -308,9 +337,10 @@
"""
Public method to get the values of a watch expression given by index.
- @param index index of the watch expression (QModelIndex)
- @return watch expression (list of six values (expression,
- special condition, temporary flag, enabled flag, ignore count))
+ @param index index of the watch expression
+ @type QModelIndex
+ @return watch expression (tuple containing expression, special condition,
+ temporary flag, enabled flag, ignore count)
@rtype tuple of (str, str, bool, bool, int)
"""
if index.isValid():
@@ -332,9 +362,12 @@
Public method to get the index of a watch expression given by
expression.
- @param cond expression of the watch expression (string)
- @param special special condition of the watch expression (string)
- @return index (QModelIndex)
+ @param cond expression of the watch expression
+ @type str
+ @param special special condition of the watch expression
+ @type str
+ @return index
+ @rtype QModelIndex
"""
for row in range(len(self.watchpoints)):
wp = self.watchpoints[row]
