src/eric7/QScintilla/Exporters/ExporterHTML.py

branch
eric7
changeset 10431
64157aeb0312
parent 10373
093dcebe5ecb
child 10439
21c28b0f9e41
--- a/src/eric7/QScintilla/Exporters/ExporterHTML.py	Wed Dec 20 19:28:22 2023 +0100
+++ b/src/eric7/QScintilla/Exporters/ExporterHTML.py	Thu Dec 21 12:03:40 2023 +0100
@@ -36,7 +36,8 @@
         """
         Constructor
 
-        @param editor reference to the editor object (QScintilla.Editor.Editor)
+        @param editor reference to the editor object
+        @type QScintilla.Editor.Editor
         """
         self.editor = editor
 
@@ -52,15 +53,22 @@
         """
         Public method to generate HTML for the source editor.
 
-        @param tabSize size of tabs (integer)
-        @param useTabs flag indicating the use of tab characters (boolean)
-        @param wysiwyg flag indicating colorization (boolean)
+        @param tabSize size of tabs
+        @type int
+        @param useTabs flag indicating the use of tab characters
+        @type bool
+        @param wysiwyg flag indicating colorization
+        @type bool
         @param folding flag indicating usage of fold markers
+        @type bool
         @param onlyStylesUsed flag indicating to include only style
-            definitions for styles used in the source (boolean)
+            definitions for styles used in the source
+        @type bool
         @param titleFullPath flag indicating to include the full file path
-            in the title tag (boolean)
-        @return generated HTML text (string)
+            in the title tag
+        @type bool
+        @return generated HTML text
+        @rtype str
         """
         self.editor.recolor(0, -1)
 
@@ -405,8 +413,10 @@
         """
         Constructor
 
-        @param editor reference to the editor object (QScintilla.Editor.Editor)
-        @param parent parent object of the exporter (QObject)
+        @param editor reference to the editor object
+        @type QScintilla.Editor.Editor
+        @param parent parent object of the exporter
+        @type QObject
         """
         ExporterBase.__init__(self, editor, parent)
 
@@ -501,7 +511,8 @@
         """
         Private method to convert ReST text into HTML using 'docutils'.
 
-        @return processed HTML (string)
+        @return processed HTML
+        @rtype str
         """
         if "sphinx" in sys.modules:
             # Make sure any Sphinx polution of docutils has been removed.

eric ide

mercurial