eric7/WebBrowser/QtHelp/HelpDocsInstaller.py

branch
eric7
changeset 8685
b0669ce1066d
parent 8602
4cff99ec9550
child 8881
54e42bc2437a
--- a/eric7/WebBrowser/QtHelp/HelpDocsInstaller.py	Wed Oct 13 18:15:30 2021 +0200
+++ b/eric7/WebBrowser/QtHelp/HelpDocsInstaller.py	Thu Oct 14 20:15:58 2021 +0200
@@ -36,7 +36,8 @@
         """
         Constructor
         
-        @param collection full pathname of the collection file (string)
+        @param collection full pathname of the collection file
+        @type str
         """
         super().__init__()
         
@@ -111,10 +112,14 @@
         """
         Private method to install/update a Qt help document.
         
-        @param name name of the Qt help document (string)
-        @param version Qt version of the help documents (integer)
-        @param engine reference to the help engine (QHelpEngineCore)
-        @return flag indicating success (boolean)
+        @param name name of the Qt help document
+        @type str
+        @param version Qt version of the help documents
+        @type int
+        @param engine reference to the help engine
+        @type QHelpEngineCore
+        @return flag indicating success
+        @rtype bool
         """
         versionKey = "qt_version_{0}@@{1}".format(version, name)
         info = engine.customValue(versionKey, "")
@@ -192,8 +197,10 @@
         """
         Private method to install/update the eric help documentation.
         
-        @param engine reference to the help engine (QHelpEngineCore)
-        @return flag indicating success (boolean)
+        @param engine reference to the help engine
+        @type QHelpEngineCore
+        @return flag indicating success
+        @rtype bool
         """
         versionKey = "eric7_ide"
         info = engine.customValue(versionKey, "")

eric ide

mercurial