Mercurial Repositories > eric / file diff

--- a/Plugins/WizardPlugins/EricPluginWizard/Templates.py	Tue Jan 16 14:16:29 2018 +0100
+++ b/Plugins/WizardPlugins/EricPluginWizard/Templates.py	Wed Jan 17 13:41:50 2018 +0100
@@ -59,16 +59,18 @@
         """
         Constructor
         
-        @param ui reference to the user interface object (UI.UserInterface)
+        @param ui reference to the user interface object
+        @type UI.UserInterface
         """
         super({className}, self).__init__(ui)
         self.__ui = ui
     
     def activate(self):
         """
-        Public method to activate this plugin.
+        Public method to activate this plug-in.
         
-        @return tuple of None and activation status (boolean)
+        @return tuple of None and activation status
+        @rtype bool
         """
         global error
         error = ""     # clear previous error
@@ -77,7 +79,7 @@
     
     def deactivate(self):
         """
-        Public method to deactivate this plugin.
+        Public method to deactivate this plug-in.
         """
         pass
 {config3}'''
@@ -91,6 +93,7 @@
     Module function returning data as required by the configuration dialog.
     
     @return dictionary containing the relevant data
+    @rtype dict
     """
     return {{
         "<unique key>": ["<display string>", "<pixmap filename>",
@@ -100,7 +103,7 @@
 
 def prepareUninstall():
     """
-    Module function to prepare for an uninstallation.
+    Module function to prepare for an un-installation.
     """
     Preferences.Prefs.settings.remove({className}.PreferencesKey)
 
@@ -115,19 +118,23 @@
     
     def getPreferences(self, key):
         """
-        Public method to retrieve the various refactoring settings.
+        Public method to retrieve the various settings values.
         
         @param key the key of the value to get
-        @return the requested refactoring setting
+        @type str
+        @return the requested setting value
+        @rtype any
         """
         return None
     
     def setPreferences(self, key, value):
         """
-        Public method to store the various refactoring settings.
+        Public method to store the various settings values.
         
-        @param key the key of the setting to be set (string)
+        @param key the key of the setting to be set
+        @type str
         @param value the value to be set
+        @type any
         """
         pass
 '''
@@ -140,7 +147,8 @@
     """
     Module function to return a preview pixmap.
     
-    @return preview pixmap (QPixmap)
+    @return preview pixmap
+    @rtype QPixmap
     """
     from PyQt5.QtGui import QPixmap
     
@@ -156,6 +164,7 @@
     
     @return list of dictionaries containing the data to query the presence of
         the executable
+    @rtype list of dict
     """
     dataList = []
     data = {
@@ -164,6 +173,7 @@
         "exe": "dummyExe",
         "versionCommand": "--version",
         "versionStartsWith": "dummyExe",
+        "versionRe": "",
         "versionPosition": -1,
         "version": "",
         "versionCleanup": None,
@@ -183,6 +193,7 @@
     
     @return dictionary containing the data to query the presence of
         the executable
+    @rtype dict
     """
     data = {
         "programEntry": True,
@@ -190,6 +201,7 @@
         "exe": exe,
         "versionCommand": "--version",
         "versionStartsWith": "<identifier>",
+        "versionRe": "",
         "versionPosition": -1,
         "version": "",
         "versionCleanup": None,
@@ -211,10 +223,12 @@
 
 apiFilesTemplate = '''def apiFiles(language):
     """
-    Module function to return the API files made available by this plugin.
+    Module function to return the API files made available by this plug-in.
     
-    @param language language to get APIs for (string)
-    @return list of API filenames (list of string)
+    @param language language to get APIs for
+    @type str
+    @return list of API filenames
+    @rtype list of str
     """
     if language in ["Python3",  "Python2", "Python"]:
         apisDir = \\