eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpDocsInstaller.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7960
e8fc383322f7
--- a/eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpDocsInstaller.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpDocsInstaller.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,39 +18,50 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.WebBrowser.QtHelp.HelpDocsInstaller</h1>
+
 <p>
 Module implementing a thread class populating and updating the QtHelp
 documentation database.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
+
 <tr>
 <td><a href="#HelpDocsInstaller">HelpDocsInstaller</a></td>
 <td>Class implementing the worker thread populating and updating the QtHelp documentation database.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="HelpDocsInstaller" ID="HelpDocsInstaller"></a>
 <h2>HelpDocsInstaller</h2>
+
 <p>
     Class implementing the worker thread populating and updating the QtHelp
     documentation database.
-</p><h3>Signals</h3>
+</p>
+<h3>Signals</h3>
 <dl>
+
 <dt>docsInstalled(bool)</dt>
 <dd>
 emitted after the installation has finished
-</dd><dt>errorMessage(str)</dt>
+</dd>
+<dt>errorMessage(str)</dt>
 <dd>
 emitted, if an error occurred during
         the installation of the documentation
@@ -59,98 +70,130 @@
 <h3>Derived from</h3>
 QThread
 <h3>Class Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+
 <table>
+
 <tr>
 <td><a href="#HelpDocsInstaller.__init__">HelpDocsInstaller</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HelpDocsInstaller.__installEric6Doc">__installEric6Doc</a></td>
 <td>Private method to install/update the eric6 help documentation.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HelpDocsInstaller.__installQtDoc">__installQtDoc</a></td>
 <td>Private method to install/update a Qt help document.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HelpDocsInstaller.installDocs">installDocs</a></td>
 <td>Public method to start the installation procedure.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HelpDocsInstaller.run">run</a></td>
 <td>Public method executed by the thread.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HelpDocsInstaller.stop">stop</a></td>
 <td>Public slot to stop the installation procedure.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="HelpDocsInstaller.__init__" ID="HelpDocsInstaller.__init__"></a>
 <h4>HelpDocsInstaller (Constructor)</h4>
 <b>HelpDocsInstaller</b>(<i>collection</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>collection</i></dt>
 <dd>
 full pathname of the collection file (string)
 </dd>
-</dl><a NAME="HelpDocsInstaller.__installEric6Doc" ID="HelpDocsInstaller.__installEric6Doc"></a>
+</dl>
+<a NAME="HelpDocsInstaller.__installEric6Doc" ID="HelpDocsInstaller.__installEric6Doc"></a>
 <h4>HelpDocsInstaller.__installEric6Doc</h4>
 <b>__installEric6Doc</b>(<i>engine</i>)
+
 <p>
         Private method to install/update the eric6 help documentation.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>engine</i></dt>
 <dd>
 reference to the help engine (QHelpEngineCore)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
-</dl><a NAME="HelpDocsInstaller.__installQtDoc" ID="HelpDocsInstaller.__installQtDoc"></a>
+</dl>
+<a NAME="HelpDocsInstaller.__installQtDoc" ID="HelpDocsInstaller.__installQtDoc"></a>
 <h4>HelpDocsInstaller.__installQtDoc</h4>
 <b>__installQtDoc</b>(<i>name, version, engine</i>)
+
 <p>
         Private method to install/update a Qt help document.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>name</i></dt>
 <dd>
 name of the Qt help document (string)
-</dd><dt><i>version</i></dt>
+</dd>
+<dt><i>version</i></dt>
 <dd>
 Qt version of the help documens (integer)
-</dd><dt><i>engine</i></dt>
+</dd>
+<dt><i>engine</i></dt>
 <dd>
 reference to the help engine (QHelpEngineCore)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
-</dl><a NAME="HelpDocsInstaller.installDocs" ID="HelpDocsInstaller.installDocs"></a>
+</dl>
+<a NAME="HelpDocsInstaller.installDocs" ID="HelpDocsInstaller.installDocs"></a>
 <h4>HelpDocsInstaller.installDocs</h4>
 <b>installDocs</b>(<i></i>)
+
 <p>
         Public method to start the installation procedure.
-</p><a NAME="HelpDocsInstaller.run" ID="HelpDocsInstaller.run"></a>
+</p>
+<a NAME="HelpDocsInstaller.run" ID="HelpDocsInstaller.run"></a>
 <h4>HelpDocsInstaller.run</h4>
 <b>run</b>(<i></i>)
+
 <p>
         Public method executed by the thread.
-</p><a NAME="HelpDocsInstaller.stop" ID="HelpDocsInstaller.stop"></a>
+</p>
+<a NAME="HelpDocsInstaller.stop" ID="HelpDocsInstaller.stop"></a>
 <h4>HelpDocsInstaller.stop</h4>
 <b>stop</b>(<i></i>)
+
 <p>
         Public slot to stop the installation procedure.
 </p>

eric ide

mercurial