src/eric7/Documentation/Source/eric7.UI.Previewers.PreviewerHTML.html

branch
eric7
changeset 10433
328f3ec4b77a
parent 9447
662075aa9361
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.UI.Previewers.PreviewerHTML.html	Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.UI.Previewers.PreviewerHTML.html	Thu Dec 21 19:50:01 2023 +0100
@@ -125,9 +125,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object
 </dd>
 </dl>
 <a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a>
@@ -179,25 +179,30 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to be processed (string)
+text to be processed
 </dd>
-<dt><i>useSphinx</i></dt>
+<dt><i>useSphinx</i> (bool)</dt>
 <dd>
 flag indicating to use Sphinx to generate the
-            ReST preview (boolean)
+            ReST preview
 </dd>
-<dt><i>restDocutilsHtmlFormat</i></dt>
+<dt><i>restDocutilsHtmlFormat</i> (str)</dt>
 <dd>
 HTML format to be generated by docutils
-            (string)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-processed HTML (string)
+processed HTML
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a>
@@ -209,19 +214,25 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to be processed (string)
+text to be processed
 </dd>
-<dt><i>htmlFormat</i></dt>
+<dt><i>htmlFormat</i> (str)</dt>
 <dd>
-HTML format to be generated (string)
+HTML format to be generated
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-processed HTML (string)
+processed HTML
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="PreviewProcessingThread.__convertReSTSphinx" ID="PreviewProcessingThread.__convertReSTSphinx"></a>
@@ -233,15 +244,21 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to be processed (string)
+text to be processed
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-processed HTML (string)
+processed HTML
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a>
@@ -352,24 +369,29 @@
 </p>
 <dl>
 
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
 <dd>
-text to be processed (string)
+text to be processed
 </dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
 name of the file associated with the given text
-            (string)
 </dd>
-<dt><i>root</i></dt>
+<dt><i>root</i> (str)</dt>
 <dd>
-directory of the document root (string)
+directory of the document root
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-processed HTML (string)
+processed HTML
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a>
@@ -529,9 +551,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="PreviewerHTML.__execJavaScript" ID="PreviewerHTML.__execJavaScript"></a>
@@ -606,9 +628,9 @@
 </p>
 <dl>
 
-<dt><i>enable</i></dt>
+<dt><i>enable</i> (bool)</dt>
 <dd>
-flag indicating the enable state (boolean)
+flag indicating the enable state
 </dd>
 </dl>
 <a NAME="PreviewerHTML.__showLink" ID="PreviewerHTML.__showLink"></a>
@@ -641,9 +663,9 @@
 </p>
 <dl>
 
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
 <dd>
-state of the checkbox (boolean)
+state of the checkbox
 </dd>
 </dl>
 <a NAME="PreviewerHTML.on_previewView_titleChanged" ID="PreviewerHTML.on_previewView_titleChanged"></a>
@@ -655,9 +677,9 @@
 </p>
 <dl>
 
-<dt><i>title</i></dt>
+<dt><i>title</i> (str)</dt>
 <dd>
-new title (string)
+new title
 </dd>
 </dl>
 <a NAME="PreviewerHTML.on_ssiCheckBox_clicked" ID="PreviewerHTML.on_ssiCheckBox_clicked"></a>
@@ -669,9 +691,9 @@
 </p>
 <dl>
 
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
 <dd>
-state of the checkbox (boolean)
+state of the checkbox
 </dd>
 </dl>
 <a NAME="PreviewerHTML.processEditor" ID="PreviewerHTML.processEditor"></a>
@@ -683,9 +705,9 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-editor to be processed (Editor)
+editor to be processed
 </dd>
 </dl>
 <a NAME="PreviewerHTML.resultCallback" ID="PreviewerHTML.resultCallback"></a>

eric ide

mercurial