Mercurial Repositories > eric / file diff

diff -r c712d09cc839 -r f6881d10e995 src/eric7/VCS/StatusMonitorThread.py
--- a/src/eric7/VCS/StatusMonitorThread.py	Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/VCS/StatusMonitorThread.py	Fri Dec 22 17:24:07 2023 +0100
@@ -34,10 +34,14 @@
         """
         Constructor
 
-        @param interval new interval in seconds (integer)
-        @param project reference to the project object (Project)
+        @param interval new interval in seconds
+        @type int
+        @param project reference to the project object
+        @type Project
         @param vcs reference to the version control object
-        @param parent reference to the parent object (QObject)
+        @type VersionControl
+        @param parent reference to the parent object
+        @type QObject
         """
         super().__init__(parent)
         self.setObjectName("VcsStatusMonitorThread")
@@ -129,7 +133,8 @@
         """
         Public method to change the monitor interval.
 
-        @param interval new interval in seconds (integer)
+        @param interval new interval in seconds
+        @type int
         """
         locked = self.monitorMutex.tryLock()
         self.interval = interval
@@ -141,7 +146,8 @@
         """
         Public method to get the monitor interval.
 
-        @return interval in seconds (integer)
+        @return interval in seconds
+        @rtype int
         """
         return self.interval
 
@@ -149,7 +155,8 @@
         """
         Public method to enable the auto update function.
 
-        @param auto status of the auto update function (boolean)
+        @param auto status of the auto update function
+        @type bool
         """
         self.autoUpdate = auto
 
@@ -157,7 +164,8 @@
         """
         Public method to retrieve the status of the auto update function.
 
-        @return status of the auto update function (boolean)
+        @return status of the auto update function
+        @rtype bool
         """
         return self.autoUpdate
 
@@ -184,7 +192,8 @@
         """
         Public method to clear the cached VCS state of a file/directory.
 
-        @param name name of the entry to be cleared (string)
+        @param name name of the entry to be cleared
+        @type str
         """
         key = self.project.getRelativePath(name)
         with contextlib.suppress(KeyError):
@@ -210,8 +219,9 @@
             <li>" " path is back at normal</li>
         </ul>
 
-        @return tuple of flag indicating successful operation (boolean) and
-            a status message in case of non successful operation (string)
+        @return tuple of flag indicating successful operation and
+            a status message in case of non successful operation
+        @rtype tuple of (bool, str)
         @exception NotImplementedError to indicate that this method must be
             implemented by a subclass
         """