src/eric7/PluginManager/PluginInstallDialog.py

branch
eric7
changeset 10428
a071d4065202
parent 10080
f834e57a5b13
child 10439
21c28b0f9e41
--- a/src/eric7/PluginManager/PluginInstallDialog.py	Wed Dec 20 11:06:38 2023 +0100
+++ b/src/eric7/PluginManager/PluginInstallDialog.py	Wed Dec 20 14:58:58 2023 +0100
@@ -48,9 +48,12 @@
         Constructor
 
         @param pluginManager reference to the plugin manager object
+        @type PluginManager
         @param pluginFileNames list of plugin files suggested for
-            installation (list of strings)
-        @param parent parent of this dialog (QWidget)
+            installation
+        @type list of str
+        @param parent parent of this dialog
+        @type QWidget
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -110,7 +113,8 @@
         """
         Public method to check, if a restart of the IDE is required.
 
-        @return flag indicating a restart is required (boolean)
+        @return flag indicating a restart is required
+        @rtype bool
         """
         return self.__restartNeeded
 
@@ -118,7 +122,8 @@
         """
         Private method to create a list of plugin archive names.
 
-        @return list of plugin archive names (list of strings)
+        @return list of plugin archive names
+        @rtype list of str
         """
         archivesList = []
         for row in range(self.archivesList.count()):
@@ -206,7 +211,8 @@
         """
         Private slot to handle the click of a button of the button box.
 
-        @param button reference to the button pressed (QAbstractButton)
+        @param button reference to the button pressed
+        @type QAbstractButton
         """
         if button == self.__backButton:
             self.__currentIndex -= 1
@@ -227,7 +233,8 @@
         """
         Private method to install the selected plugin archives.
 
-        @return flag indicating success (boolean)
+        @return flag indicating success
+        @rtype bool
         """
         res = True
         self.summaryEdit.clear()
@@ -256,10 +263,12 @@
         Private slot to install the selected plugin.
 
         @param archiveFilename name of the plugin archive
-            file (string)
+            file
+        @type str
         @return flag indicating success (boolean), error message
             upon failure (string) and flag indicating a restart
-            of the IDE is required (boolean)
+            of the IDE is required
+        @rtype bool
         """
         installedPluginName = ""
 
@@ -543,8 +552,10 @@
         This is an extended version of the Python one in order to
         record the created directories.
 
-        @param name name of the directory to create (string)
-        @param mode permission to set for the new directory (integer)
+        @param name name of the directory to create
+        @type str
+        @param mode permission to set for the new directory
+        @type int
         """
         head, tail = os.path.split(name)
         if not tail:
@@ -562,9 +573,12 @@
         Private method to uninstall an already installed plugin to prepare
         the update.
 
-        @param destination name of the plugin directory (string)
-        @param pluginFileName name of the plugin file (string)
-        @param packageName name of the plugin package (string)
+        @param destination name of the plugin directory
+        @type str
+        @param pluginFileName name of the plugin file
+        @type str
+        @param packageName name of the plugin package
+        @type str
         """
         packageDir = (
             None
@@ -610,9 +624,11 @@
         Constructor
 
         @param pluginManager reference to the plugin manager object
-        @param pluginFileNames list of plugin files suggested for
-            installation (list of strings)
-        @param parent reference to the parent widget (QWidget)
+        @type PluginManager
+        @param pluginFileNames list of plugin files suggested for installation
+        @type list of str
+        @param parent reference to the parent widget
+        @type QWidget
         """
         super().__init__(parent)
         self.setSizeGripEnabled(True)
@@ -634,7 +650,8 @@
         """
         Public method to check, if a restart of the IDE is required.
 
-        @return flag indicating a restart is required (boolean)
+        @return flag indicating a restart is required
+        @rtype bool
         """
         return self.cw.restartNeeded()
 
@@ -649,8 +666,10 @@
         Constructor
 
         @param pluginFileNames list of plugin files suggested for
-            installation (list of strings)
-        @param parent reference to the parent widget (QWidget)
+            installation
+        @type list of str
+        @param parent reference to the parent widget
+        @type QWidget
         """
         super().__init__(parent)
         self.cw = PluginInstallWidget(None, pluginFileNames, self)

eric ide

mercurial