src/eric7/Plugins/PluginCodeStyleChecker.py

branch
eric7
changeset 10437
2f70ca07f0af
parent 10069
435cc5875135
child 10439
21c28b0f9e41
--- a/src/eric7/Plugins/PluginCodeStyleChecker.py	Fri Dec 22 17:24:07 2023 +0100
+++ b/src/eric7/Plugins/PluginCodeStyleChecker.py	Fri Dec 22 19:45:17 2023 +0100
@@ -64,7 +64,8 @@
         """
         Constructor
 
-        @param ui reference to the user interface object (UI.UserInterface)
+        @param ui reference to the user interface object
+        @type UserInterface
         """
         super().__init__(ui)
         self.__ui = ui
@@ -94,8 +95,10 @@
         """
         Private slot handling service errors.
 
-        @param fn file name (string)
-        @param msg message text (string)
+        @param fn file name
+        @type str
+        @param msg message text
+        @type str
         """
         self.error.emit(fn, msg)
 
@@ -103,10 +106,14 @@
         """
         Public slot handling service errors for Python 3.
 
-        @param fx service name (string)
-        @param lang language (string)
-        @param fn file name (string)
-        @param msg message text (string)
+        @param fx service name
+        @type str
+        @param lang language
+        @type str
+        @param fn file name
+        @type str
+        @param msg message text
+        @type str
         """
         if fx in ["style", "batch_style"] and lang == "Python3":
             if fx == "style":
@@ -119,8 +126,10 @@
         """
         Public slot handling the completion of a batch job.
 
-        @param fx service name (string)
-        @param lang language (string)
+        @param fx service name
+        @type str
+        @param lang language
+        @type str
         """
         if fx in ["style", "batch_style"]:
             if lang in self.queuedBatches:
@@ -244,7 +253,8 @@
         """
         Public method to activate this plugin.
 
-        @return tuple of None and activation status (boolean)
+        @return tuple of None and activation status
+        @rtype bool
         """
         menu = ericApp().getObject("Project").getMenu("Checks")
         if menu:
@@ -327,8 +337,10 @@
         Private slot called, when the the project menu or a submenu is
         about to be shown.
 
-        @param menuName name of the menu to be shown (string)
-        @param menu reference to the menu (QMenu)
+        @param menuName name of the menu to be shown
+        @type str
+        @param menu reference to the menu
+        @type QMenu
         """
         if menuName == "Checks" and self.__projectAct is not None:
             self.__projectAct.setEnabled(
@@ -341,8 +353,10 @@
         Private slot called, when the the project browser menu or a submenu is
         about to be shown.
 
-        @param menuName name of the menu to be shown (string)
-        @param menu reference to the menu (QMenu)
+        @param menuName name of the menu to be shown
+        @type str
+        @param menu reference to the menu
+        @type QMenu
         """
         if menuName == "Checks" and ericApp().getObject(
             "Project"
@@ -428,7 +442,8 @@
         """
         Private slot called, when a new editor was opened.
 
-        @param editor reference to the new editor (QScintilla.Editor)
+        @param editor reference to the new editor
+        @type Editor
         """
         menu = editor.getMenu("Checks")
         if menu is not None:
@@ -440,7 +455,8 @@
         """
         Private slot called, when an editor was closed.
 
-        @param editor reference to the editor (QScintilla.Editor)
+        @param editor reference to the editor
+        @type Editor
         """
         with contextlib.suppress(ValueError):
             self.__editors.remove(editor)
@@ -450,9 +466,12 @@
         Private slot called, when the the editor context menu or a submenu is
         about to be shown.
 
-        @param menuName name of the menu to be shown (string)
-        @param menu reference to the menu (QMenu)
+        @param menuName name of the menu to be shown
+        @type str
+        @param menu reference to the menu
+        @type QMenu
         @param editor reference to the editor
+        @type Editor
         """
         if menuName == "Checks":
             if self.__editorAct not in menu.actions():

eric ide

mercurial