src/eric7/QScintilla/APIsManager.py

branch
eric7
changeset 10431
64157aeb0312
parent 10373
093dcebe5ecb
child 10439
21c28b0f9e41
--- a/src/eric7/QScintilla/APIsManager.py	Wed Dec 20 19:28:22 2023 +0100
+++ b/src/eric7/QScintilla/APIsManager.py	Thu Dec 21 12:03:40 2023 +0100
@@ -97,7 +97,8 @@
         """
         Public method to get a reference to QsciAPIs object.
 
-        @return reference to the QsciAPIs object (QsciAPIs)
+        @return reference to the QsciAPIs object
+        @rtype QsciAPIs
         """
         if not self.__forPreparation and Preferences.getEditor("AutoPrepareAPIs"):
             self.prepareAPIs()
@@ -107,7 +108,8 @@
         """
         Public method to check, if the object has API files configured.
 
-        @return flag indicating no API files have been configured (boolean)
+        @return flag indicating no API files have been configured
+        @rtype bool
         """
         return len(self.__apifiles) == 0
 
@@ -138,8 +140,10 @@
         """
         Public method to prepare the APIs if necessary.
 
-        @param ondemand flag indicating a requested preparation (boolean)
-        @param rawList list of raw API files (list of strings)
+        @param ondemand flag indicating a requested preparation
+        @type bool
+        @param rawList list of raw API files
+        @type list of str
         """
         if self.__apis is None or self.__inPreparation:
             return
@@ -192,7 +196,8 @@
         """
         Public method to get a list of installed API files.
 
-        @return list of installed API files (list of strings)
+        @return list of installed API files
+        @rtype list of str
         """
         if self.__apis is not None:
             qtDataDir = QLibraryInfo.path(QLibraryInfo.LibraryPath.DataPath)
@@ -218,7 +223,8 @@
         """
         Private method returning the default name of a prepared API file.
 
-        @return complete filename for the Prepared APIs file (string)
+        @return complete filename for the Prepared APIs file
+        @rtype str
         """
         apisDir = os.path.join(Globals.getConfigDir(), "APIs")
         if self.__apis is not None:
@@ -241,7 +247,8 @@
         """
         Constructor
 
-        @param parent reference to the parent object (QObject)
+        @param parent reference to the parent object
+        @type QObject
         """
         super().__init__(parent)
         self.setObjectName("APIsManager")

eric ide

mercurial