src/eric7/WebBrowser/GreaseMonkey/GreaseMonkeyScript.py

branch
eric7
changeset 10436
f6881d10e995
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/WebBrowser/GreaseMonkey/GreaseMonkeyScript.py	Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/GreaseMonkey/GreaseMonkeyScript.py	Fri Dec 22 17:24:07 2023 +0100
@@ -48,8 +48,10 @@
         """
         Constructor
 
-        @param manager reference to the manager object (GreaseMonkeyManager)
-        @param path path of the Javascript file (string)
+        @param manager reference to the manager object
+        @type GreaseMonkeyManager
+        @param path path of the Javascript file
+        @type str
         """
         super().__init__(manager)
 
@@ -90,7 +92,8 @@
         """
         Public method to check the validity of the script.
 
-        @return flag indicating a valid script (boolean)
+        @return flag indicating a valid script
+        @rtype bool
         """
         return self.__valid
 
@@ -98,7 +101,8 @@
         """
         Public method to get the name of the script.
 
-        @return name of the script (string)
+        @return name of the script
+        @rtype str
         """
         return self.__name
 
@@ -106,7 +110,8 @@
         """
         Public method to get the name space of the script.
 
-        @return name space of the script (string)
+        @return name space of the script
+        @rtype str
         """
         return self.__namespace
 
@@ -114,7 +119,8 @@
         """
         Public method to get the full name of the script.
 
-        @return full name of the script (string)
+        @return full name of the script
+        @rtype str
         """
         return "{0}/{1}".format(self.__namespace, self.__name)
 
@@ -122,7 +128,8 @@
         """
         Public method to get the description of the script.
 
-        @return description of the script (string)
+        @return description of the script
+        @rtype str
         """
         return self.__description
 
@@ -130,7 +137,8 @@
         """
         Public method to get the version of the script.
 
-        @return version of the script (string)
+        @return version of the script
+        @rtype str
         """
         return self.__version
 
@@ -147,7 +155,8 @@
         """
         Public method to get the icon URL of the script.
 
-        @return icon URL of the script (QUrl)
+        @return icon URL of the script
+        @rtype QUrl
         """
         return QUrl(self.__iconUrl)
 
@@ -155,7 +164,8 @@
         """
         Public method to get the download URL of the script.
 
-        @return download URL of the script (QUrl)
+        @return download URL of the script
+        @rtype QUrl
         """
         return QUrl(self.__downloadUrl)
 
@@ -163,7 +173,8 @@
         """
         Public method to get the update URL of the script.
 
-        @return update URL of the script (QUrl)
+        @return update URL of the script
+        @rtype QUrl
         """
         return QUrl(self.__updateUrl)
 
@@ -171,7 +182,8 @@
         """
         Public method to get the start point of the script.
 
-        @return start point of the script (DocumentStart or DocumentEnd)
+        @return start point of the script
+        @rtype DocumentStart or DocumentEnd
         """
         return self.__startAt
 
@@ -188,7 +200,8 @@
         """
         Public method to check, if the script is enabled.
 
-        @return flag indicating an enabled state (boolean)
+        @return flag indicating an enabled state
+        @rtype bool
         """
         return self.__enabled and self.__valid
 
@@ -196,7 +209,8 @@
         """
         Public method to enable a script.
 
-        @param enable flag indicating the new enabled state (boolean)
+        @param enable flag indicating the new enabled state
+        @type bool
         """
         self.__enabled = enable
 
@@ -204,7 +218,8 @@
         """
         Public method to get the list of included URLs.
 
-        @return list of included URLs (list of strings)
+        @return list of included URLs
+        @rtype list of str
         """
         return self.__include[:]
 
@@ -212,7 +227,8 @@
         """
         Public method to get the list of excluded URLs.
 
-        @return list of excluded URLs (list of strings)
+        @return list of excluded URLs
+        @rtype list of str
         """
         return self.__exclude[:]
 
@@ -220,7 +236,8 @@
         """
         Public method to get the list of required scripts.
 
-        @return list of required scripts (list of strings)
+        @return list of required scripts
+        @rtype list of str
         """
         return self.__require[:]
 
@@ -228,7 +245,8 @@
         """
         Public method to get the path of the Javascript file.
 
-        @return path of the Javascript file (string)
+        @return path of the Javascript file
+        @rtype str
         """
         return self.__fileName
 

eric ide

mercurial