Added comments to 50 functions across 7 files

Author: komment-ai[bot]

IROS_experiments/person_controller_webots/src/genericworker.py

@@ -39,6 +39,24 @@ class GenericWorker(QtCore.QObject):
     kill = QtCore.Signal()
 
     def __init__(self, mprx):
+        """
+        establishes a `QMutex` and `QTimer` instance, setting the period to 30,
+        to manage access to and timing of tasks.
+
+        Args:
+            mprx (`object`/`instance`.): Qt core mutex, which is used to implement
+                recursive mutual exclusion.
+                
+                		- `super(GenericWorker, self).__init__()` calls the constructor
+                of the parent class `QtCore.QObject`.
+                		- `self.mutex = QtCore.QMutex(QtCore.QMutex.Recursive)` creates
+                a recursive mutex with a name "mutex".
+                		- `self.Period = 30` sets the period of the worker to 30 seconds.
+                		- `self.timer = QtCore.QTimer(self)` creates an instance of the
+                timer class and stores it in the member variable `self.timer`.
+                
+
+        """
         super(GenericWorker, self).__init__()
 
 
@@ -49,13 +67,28 @@ def __init__(self, mprx):
 
     @QtCore.Slot()
     def killYourSelf(self):
+        """
+        emits the `kill` signal, which is likely to cause an immediate termination
+        or shutdown of the program or component that contains the function.
+
+        """
         rDebug("Killing myself")
         self.kill.emit()
 
     # \brief Change compute period
     # @param per Period in ms
     @QtCore.Slot(int)
     def setPeriod(self, p):
+        """
+        updates the instance variable ` Period` and starts a timer with the new
+        period value using the `timer.start()` method.
+
+        Args:
+            p (float): new period to be set for the instance's timer, and it is
+                used to update the ` Period` attribute and start the timer with
+                the new period.
+
+        """
         print("Period changed", p)
         self.Period = p
         self.timer.start(self.Period)