Mercurial Repositories > eric / file diff

--- a/src/eric7/UI/Previewers/PreviewerHTML.py	Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/UI/Previewers/PreviewerHTML.py	Thu Dec 21 19:50:01 2023 +0100
@@ -43,7 +43,8 @@
         """
         Constructor
 
-        @param parent reference to the parent widget (QWidget)
+        @param parent reference to the parent widget
+        @type QWidget
         """
         super().__init__(parent)
 
@@ -144,7 +145,8 @@
         """
         Private slot to enable/disable JavaScript.
 
-        @param checked state of the checkbox (boolean)
+        @param checked state of the checkbox
+        @type bool
         """
         Preferences.setUI("ShowFilePreviewJS", checked)
         self.__setJavaScriptEnabled(checked)
@@ -153,7 +155,8 @@
         """
         Private method to enable/disable JavaScript.
 
-        @param enable flag indicating the enable state (boolean)
+        @param enable flag indicating the enable state
+        @type bool
         """
         self.jsCheckBox.setChecked(enable)
 
@@ -167,7 +170,8 @@
         """
         Private slot to enable/disable SSI.
 
-        @param checked state of the checkbox (boolean)
+        @param checked state of the checkbox
+        @type bool
         """
         Preferences.setUI("ShowFilePreviewSSI", checked)
         self.processEditor()
@@ -186,7 +190,8 @@
         """
         Public slot to process an editor's text.
 
-        @param editor editor to be processed (Editor)
+        @param editor editor to be processed
+        @type Editor
         """
         if not self.__previewAvailable:
             return
@@ -278,7 +283,8 @@
         """
         Private slot to handle a change of the title.
 
-        @param title new title (string)
+        @param title new title
+        @type str
         """
         if title:
             self.titleLabel.setText(self.tr("Preview - {0}").format(title))
@@ -367,7 +373,8 @@
         """
         Constructor
 
-        @param parent reference to the parent object (QObject)
+        @param parent reference to the parent object
+        @type QObject
         """
         super().__init__()
 
@@ -531,11 +538,14 @@
 
         Note: Only a limited subset of SSI statements are supported.
 
-        @param txt text to be processed (string)
+        @param txt text to be processed
+        @type str
         @param filename name of the file associated with the given text
-            (string)
-        @param root directory of the document root (string)
-        @return processed HTML (string)
+        @type str
+        @param root directory of the document root
+        @type str
+        @return processed HTML
+        @rtype str
         """
         if not filename:
             return txt
@@ -615,12 +625,15 @@
         """
         Private method to convert ReST text into HTML.
 
-        @param text text to be processed (string)
+        @param text text to be processed
+        @type str
         @param useSphinx flag indicating to use Sphinx to generate the
-            ReST preview (boolean)
+            ReST preview
+        @type bool
         @param restDocutilsHtmlFormat HTML format to be generated by docutils
-            (string)
-        @return processed HTML (string)
+        @type str
+        @return processed HTML
+        @rtype str
         """
         if useSphinx:
             return self.__convertReSTSphinx(text)
@@ -631,8 +644,10 @@
         """
         Private method to convert ReST text into HTML using 'sphinx'.
 
-        @param text text to be processed (string)
-        @return processed HTML (string)
+        @param text text to be processed
+        @type str
+        @return processed HTML
+        @rtype str
         """
         try:
             from sphinx.application import (  # __IGNORE_EXCEPTION__ __IGNORE_WARNING__
@@ -693,9 +708,12 @@
         """
         Private method to convert ReST text into HTML using 'docutils'.
 
-        @param text text to be processed (string)
-        @param htmlFormat HTML format to be generated (string)
-        @return processed HTML (string)
+        @param text text to be processed
+        @type str
+        @param htmlFormat HTML format to be generated
+        @type str
+        @return processed HTML
+        @rtype str
         """
         if "sphinx" in sys.modules:
             # Make sure any Sphinx polution of docutils has been removed.