src/eric7/EricWidgets/EricLed.py

branch
eric7
changeset 10423
299802979277
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/EricWidgets/EricLed.py	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/EricWidgets/EricLed.py	Tue Dec 19 19:57:08 2023 +0100
@@ -76,7 +76,8 @@
         """
         Private method to calculate the width of the LED.
 
-        @return new width of the LED (integer)
+        @return new width of the LED
+        @rtype int
         """
         width = min(self.width(), self.height())
         width -= 2  # leave one pixel border
@@ -140,7 +141,8 @@
         """
         Public method to return the LED state.
 
-        @return flag indicating the light state (boolean)
+        @return flag indicating the light state
+        @rtype bool
         """
         return self.__led_on
 
@@ -157,7 +159,8 @@
         """
         Public method to return the LED rectangular ratio [= width / height].
 
-        @return LED rectangular ratio (float)
+        @return LED rectangular ratio
+        @rtype float
         """
         return self.__rectRatio
 
@@ -165,7 +168,8 @@
         """
         Public method to return the LED color.
 
-        @return color of the LED (QColor)
+        @return color of the LED
+        @rtype QColor
         """
         return self.__led_color
 
@@ -173,7 +177,8 @@
         """
         Public method to set the LED to on.
 
-        @param state new state of the LED (boolean)
+        @param state new state of the LED
+        @type bool
         """
         if self.__led_on != state:
             self.__led_on = state
@@ -194,7 +199,8 @@
         """
         Public method to set the LED rectangular ratio (width / height).
 
-        @param ratio new LED rectangular ratio (float)
+        @param ratio new LED rectangular ratio
+        @type float
         """
         if self.__rectRatio != ratio:
             self.__rectRatio = ratio
@@ -204,7 +210,8 @@
         """
         Public method to set the LED color.
 
-        @param color color for the LED (QColor)
+        @param color color for the LED
+        @type QColor
         """
         if self.__led_color != color:
             self.__led_color = color
@@ -215,7 +222,8 @@
         """
         Public method to set the dark factor.
 
-        @param darkfactor value to set for the dark factor (integer)
+        @param darkfactor value to set for the dark factor
+        @type int
         """
         if self.__dark_factor != darkfactor:
             self.__dark_factor = darkfactor
@@ -226,7 +234,8 @@
         """
         Public method to return the dark factor.
 
-        @return the current dark factor (integer)
+        @return the current dark factor
+        @rtype int
         """
         return self.__dark_factor
 
@@ -252,7 +261,8 @@
         """
         Public slot to set the __framedLed attribute.
 
-        @param framed flag indicating the framed state (boolean)
+        @param framed flag indicating the framed state
+        @type bool
         """
         if self.__framedLed != framed:
             self.__framedLed = framed
@@ -264,7 +274,8 @@
         """
         Public method to return the framed state.
 
-        @return flag indicating the current framed state (boolean)
+        @return flag indicating the current framed state
+        @rtype bool
         """
         return self.__framedLed
 
@@ -272,7 +283,8 @@
         """
         Public method to give a hint about our desired size.
 
-        @return size hint (QSize)
+        @return size hint
+        @rtype QSize
         """
         return QSize(18, 18)
 
@@ -280,7 +292,8 @@
         """
         Public method to give a hint about our minimum size.
 
-        @return size hint (QSize)
+        @return size hint
+        @rtype QSize
         """
         return QSize(18, 18)
 
@@ -321,7 +334,8 @@
         """
         Protected method handling mouse release events.
 
-        @param evt mouse event (QMouseEvent)
+        @param evt mouse event
+        @type QMouseEvent
         """
         if evt.button() == Qt.MouseButton.LeftButton and self.rect().contains(
             evt.position().toPoint()

eric ide

mercurial