Mercurial Repositories > eric / file diff

--- a/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleChecker.py	Fri Dec 22 17:24:07 2023 +0100
+++ b/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleChecker.py	Fri Dec 22 19:45:17 2023 +0100
@@ -38,7 +38,8 @@
     """
     Initialize the service and return the entry point.
 
-    @return the entry point for the background client (function)
+    @return the entry point for the background client
+    @rtype function
     """
     return codeStyleCheck
 
@@ -47,7 +48,8 @@
     """
     Initialize the batch service and return the entry point.
 
-    @return the entry point for the background client (function)
+    @return the entry point for the background client
+    @rtype function
     """
     return codeStyleBatchCheck
 
@@ -61,7 +63,8 @@
         """
         Constructor
 
-        @param options options for the report (optparse.Values)
+        @param options options for the report
+        @type optparse.Values
         """
         super().__init__(options)
 
@@ -72,12 +75,18 @@
         """
         Public method to collect the error messages.
 
-        @param line_number line number of the issue (integer)
-        @param offset position within line of the issue (integer)
-        @param errorCode error message code (string)
-        @param check reference to the checker function (function)
-        @param args arguments for the message (list)
-        @return error code (string)
+        @param line_number line number of the issue
+        @type int
+        @param offset position within line of the issue
+        @type int
+        @param errorCode error message code
+        @type str
+        @param check reference to the checker function
+        @type function
+        @param args arguments for the message
+        @type list
+        @return error code
+        @rtype str
         """
         errorCode = super().error_args(line_number, offset, errorCode, check, *args)
         if errorCode and (self.counters[errorCode] == 1 or self.__repeat):
@@ -98,11 +107,16 @@
     Function to extract flags starting and ending with '__' from a line
     comment.
 
-    @param line line to extract flags from (string)
-    @param startComment string identifying the start of the comment (string)
-    @param endComment string identifying the end of a comment (string)
-    @param flagsLine flag indicating to check for a flags only line (bool)
-    @return list containing the extracted flags (list of strings)
+    @param line line to extract flags from
+    @type str
+    @param startComment string identifying the start of the comment
+    @type str
+    @param endComment string identifying the end of a comment
+    @type str
+    @param flagsLine flag indicating to check for a flags only line
+    @type bool
+    @return list containing the extracted flags
+    @rtype list of str
     """
     flags = []
 
@@ -293,8 +307,10 @@
     """
     Module function acting as the parallel worker for the style check.
 
-    @param inputQueue input queue (multiprocessing.Queue)
-    @param outputQueue output queue (multiprocessing.Queue)
+    @param inputQueue input queue
+    @type multiprocessing.Queue
+    @param outputQueue output queue
+    @type multiprocessing.Queue
     """
     for filename, source, args in iter(inputQueue.get, "STOP"):
         result = __checkCodeStyle(filename, source, args)