Updated source documentation. eric7

Tue, 21 Jun 2022 17:15:52 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Tue, 21 Jun 2022 17:15:52 +0200
branch
eric7
changeset 9164
111fe229ee4f
parent 9163
9ae6990affcd
child 9165
17617e5d5473

Updated source documentation.

eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.EricNetwork.EricTldExtractor.html file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.HexEdit.HexEditWidget.html file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.WebBrowser.Tools.WebBrowserTools.html file | annotate | diff | comparison | revisions
--- a/eric7/APIs/Python3/eric7.api	Tue Jun 21 17:14:57 2022 +0200
+++ b/eric7/APIs/Python3/eric7.api	Tue Jun 21 17:15:52 2022 +0200
@@ -1126,7 +1126,6 @@
 eric7.EricNetwork.EricTldExtractor.EricTldExtractor.setDataSearchPaths?4(searchPaths=None)
 eric7.EricNetwork.EricTldExtractor.EricTldExtractor.splitParts?4(host)
 eric7.EricNetwork.EricTldExtractor.EricTldExtractor.subdomain?4(host)
-eric7.EricNetwork.EricTldExtractor.EricTldExtractor.test?4()
 eric7.EricNetwork.EricTldExtractor.EricTldExtractor.tld?4(host)
 eric7.EricNetwork.EricTldExtractor.EricTldExtractor?1(withPrivate=False, parent=None)
 eric7.EricNetwork.EricTldExtractor.EricTldHostParts?1()
@@ -12014,7 +12013,6 @@
 eric7.WebBrowser.Tools.WebBrowserTools.pixmapFromByteArray?4(data)
 eric7.WebBrowser.Tools.WebBrowserTools.pixmapToByteArray?4(pixmap)
 eric7.WebBrowser.Tools.WebBrowserTools.pixmapToDataUrl?4(pixmap, mimetype="image/png")
-eric7.WebBrowser.Tools.WebBrowserTools.readAllFileByteContents?4(filename)
 eric7.WebBrowser.Tools.WebBrowserTools.readAllFileContents?4(filename)
 eric7.WebBrowser.Tools.WebHitTestResult.WebHitTestResult.alternateText?4()
 eric7.WebBrowser.Tools.WebHitTestResult.WebHitTestResult.baseUrl?4()
Binary file eric7/Documentation/Help/source.qch has changed
--- a/eric7/Documentation/Help/source.qhp	Tue Jun 21 17:14:57 2022 +0200
+++ b/eric7/Documentation/Help/source.qhp	Tue Jun 21 17:15:52 2022 +0200
@@ -5583,7 +5583,6 @@
       <keyword name="EricTldExtractor" id="EricTldExtractor" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor" />
       <keyword name="EricTldExtractor (Constructor)" id="EricTldExtractor (Constructor)" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor.__init__" />
       <keyword name="EricTldExtractor (Module)" id="EricTldExtractor (Module)" ref="eric7.EricNetwork.EricTldExtractor.html" />
-      <keyword name="EricTldExtractor.__checkPublicSuffix" id="EricTldExtractor.__checkPublicSuffix" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor.__checkPublicSuffix" />
       <keyword name="EricTldExtractor.__defaultDataSearchPaths" id="EricTldExtractor.__defaultDataSearchPaths" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor.__defaultDataSearchPaths" />
       <keyword name="EricTldExtractor.__domainHelper" id="EricTldExtractor.__domainHelper" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor.__domainHelper" />
       <keyword name="EricTldExtractor.__loadData" id="EricTldExtractor.__loadData" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor.__loadData" />
@@ -5599,7 +5598,6 @@
       <keyword name="EricTldExtractor.setDataSearchPaths" id="EricTldExtractor.setDataSearchPaths" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor.setDataSearchPaths" />
       <keyword name="EricTldExtractor.splitParts" id="EricTldExtractor.splitParts" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor.splitParts" />
       <keyword name="EricTldExtractor.subdomain" id="EricTldExtractor.subdomain" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor.subdomain" />
-      <keyword name="EricTldExtractor.test" id="EricTldExtractor.test" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor.test" />
       <keyword name="EricTldExtractor.tld" id="EricTldExtractor.tld" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldExtractor.tld" />
       <keyword name="EricTldHostParts" id="EricTldHostParts" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldHostParts" />
       <keyword name="EricTldHostParts (Constructor)" id="EricTldHostParts (Constructor)" ref="eric7.EricNetwork.EricTldExtractor.html#EricTldHostParts.__init__" />
@@ -19042,7 +19040,6 @@
       <keyword name="queues (Module)" id="queues (Module)" ref="eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html" />
       <keyword name="quoteArgs" id="quoteArgs" ref="eric7.DebugClients.Python.DebugUtilities.html#quoteArgs" />
       <keyword name="rbclbr (Module)" id="rbclbr (Module)" ref="eric7.Utilities.ClassBrowsers.rbclbr.html" />
-      <keyword name="readAllFileByteContents" id="readAllFileByteContents" ref="eric7.WebBrowser.Tools.WebBrowserTools.html#readAllFileByteContents" />
       <keyword name="readAllFileContents" id="readAllFileContents" ref="eric7.WebBrowser.Tools.WebBrowserTools.html#readAllFileContents" />
       <keyword name="readEncodedFile" id="readEncodedFile" ref="eric7.Utilities.__init__.html#readEncodedFile" />
       <keyword name="readEncodedFileWithEncoding" id="readEncodedFileWithEncoding" ref="eric7.Utilities.__init__.html#readEncodedFileWithEncoding" />
--- a/eric7/Documentation/Source/eric7.EricNetwork.EricTldExtractor.html	Tue Jun 21 17:14:57 2022 +0200
+++ b/eric7/Documentation/Source/eric7.EricNetwork.EricTldExtractor.html	Tue Jun 21 17:15:52 2022 +0200
@@ -71,10 +71,6 @@
 <td>Constructor</td>
 </tr>
 <tr>
-<td><a href="#EricTldExtractor.__checkPublicSuffix">__checkPublicSuffix</a></td>
-<td>Private method to test a host name against a registrable name.</td>
-</tr>
-<tr>
 <td><a href="#EricTldExtractor.__defaultDataSearchPaths">__defaultDataSearchPaths</a></td>
 <td>Private method to get the default search paths for the TLD data file.</td>
 </tr>
@@ -135,10 +131,6 @@
 <td>Public method to get the subdomain for a host.</td>
 </tr>
 <tr>
-<td><a href="#EricTldExtractor.test">test</a></td>
-<td>Public method to execute the tests.</td>
-</tr>
-<tr>
 <td><a href="#EricTldExtractor.tld">tld</a></td>
 <td>Public method to get the top level domain for a host.</td>
 </tr>
@@ -167,36 +159,6 @@
 reference to the parent object
 </dd>
 </dl>
-<a NAME="EricTldExtractor.__checkPublicSuffix" ID="EricTldExtractor.__checkPublicSuffix"></a>
-<h4>EricTldExtractor.__checkPublicSuffix</h4>
-<b>__checkPublicSuffix</b>(<i>host, registrableName</i>)
-
-<p>
-        Private method to test a host name against a registrable name.
-</p>
-<dl>
-
-<dt><i>host</i> (str)</dt>
-<dd>
-host name to test
-</dd>
-<dt><i>registrableName</i> (str)</dt>
-<dd>
-registrable domain name to test against
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-flag indicating the check result
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-bool
-</dd>
-</dl>
 <a NAME="EricTldExtractor.__defaultDataSearchPaths" ID="EricTldExtractor.__defaultDataSearchPaths"></a>
 <h4>EricTldExtractor.__defaultDataSearchPaths</h4>
 <b>__defaultDataSearchPaths</b>(<i></i>)
@@ -546,25 +508,6 @@
 str
 </dd>
 </dl>
-<a NAME="EricTldExtractor.test" ID="EricTldExtractor.test"></a>
-<h4>EricTldExtractor.test</h4>
-<b>test</b>(<i></i>)
-
-<p>
-        Public method to execute the tests.
-</p>
-<dl>
-<dt>Return:</dt>
-<dd>
-flag indicating the test result
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-bool
-</dd>
-</dl>
 <a NAME="EricTldExtractor.tld" ID="EricTldExtractor.tld"></a>
 <h4>EricTldExtractor.tld</h4>
 <b>tld</b>(<i>host</i>)
--- a/eric7/Documentation/Source/eric7.HexEdit.HexEditWidget.html	Tue Jun 21 17:14:57 2022 +0200
+++ b/eric7/Documentation/Source/eric7.HexEdit.HexEditWidget.html	Tue Jun 21 17:15:52 2022 +0200
@@ -1658,7 +1658,7 @@
 </p>
 <dl>
 
-<dt><i>dataOrDevice</i> (bytearray, QByteArray or QIODevice)</dt>
+<dt><i>dataOrDevice</i> (bytes, bytearray, QByteArray or QIODevice)</dt>
 <dd>
 byte array or device containing the data
 </dd>
--- a/eric7/Documentation/Source/eric7.WebBrowser.Tools.WebBrowserTools.html	Tue Jun 21 17:14:57 2022 +0200
+++ b/eric7/Documentation/Source/eric7.WebBrowser.Tools.WebBrowserTools.html	Tue Jun 21 17:15:52 2022 +0200
@@ -70,10 +70,6 @@
 <td>Module function to convert a pixmap to a data: URL.</td>
 </tr>
 <tr>
-<td><a href="#readAllFileByteContents">readAllFileByteContents</a></td>
-<td>Function to read the bytes contents of the given file.</td>
-</tr>
-<tr>
 <td><a href="#readAllFileContents">readAllFileContents</a></td>
 <td>Function to read the string contents of the given file.</td>
 </tr>
@@ -403,35 +399,6 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
-<a NAME="readAllFileByteContents" ID="readAllFileByteContents"></a>
-<h2>readAllFileByteContents</h2>
-<b>readAllFileByteContents</b>(<i>filename</i>)
-
-<p>
-    Function to read the bytes contents of the given file.
-</p>
-<dl>
-
-<dt><i>filename</i> (str)</dt>
-<dd>
-name of the file
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-contents of the file
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-str
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr />
-<hr />
 <a NAME="readAllFileContents" ID="readAllFileContents"></a>
 <h2>readAllFileContents</h2>
 <b>readAllFileContents</b>(<i>filename</i>)

eric ide

mercurial