Regenerated the source code documentation. eric7

Sat, 26 Apr 2025 11:58:29 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 26 Apr 2025 11:58:29 +0200
branch
eric7
changeset 11238
ddb3c3b4d679
parent 11237
c1c31b861d54
child 11239
dff8babf4707

Regenerated the source code documentation.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2Devices.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiApConfigDialog.html file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Sat Apr 26 11:58:15 2025 +0200
+++ b/src/eric7/APIs/Python3/eric7.api	Sat Apr 26 11:58:29 2025 +0200
@@ -2781,6 +2781,7 @@
 eric7.MicroPython.Devices.CircuitPythonDevices.CircuitPythonDevice.getDocumentationUrl?4()
 eric7.MicroPython.Devices.CircuitPythonDevices.CircuitPythonDevice.getDownloadMenuEntries?4()
 eric7.MicroPython.Devices.CircuitPythonDevices.CircuitPythonDevice.getEthernetStatus?4()
+eric7.MicroPython.Devices.CircuitPythonDevices.CircuitPythonDevice.getSecurityModes?4()
 eric7.MicroPython.Devices.CircuitPythonDevices.CircuitPythonDevice.getWifiData?4()
 eric7.MicroPython.Devices.CircuitPythonDevices.CircuitPythonDevice.getWorkspace?4(silent=False)
 eric7.MicroPython.Devices.CircuitPythonDevices.CircuitPythonDevice.hasBluetooth?4()
@@ -2880,6 +2881,7 @@
 eric7.MicroPython.Devices.DeviceBase.BaseDevice.getFirmwareUrl?4()
 eric7.MicroPython.Devices.DeviceBase.BaseDevice.getLibPaths?4()
 eric7.MicroPython.Devices.DeviceBase.BaseDevice.getModules?4()
+eric7.MicroPython.Devices.DeviceBase.BaseDevice.getSecurityModes?4()
 eric7.MicroPython.Devices.DeviceBase.BaseDevice.getTime?4()
 eric7.MicroPython.Devices.DeviceBase.BaseDevice.getWifiData?4()
 eric7.MicroPython.Devices.DeviceBase.BaseDevice.getWorkspace?4()
@@ -3114,6 +3116,7 @@
 eric7.MicroPython.Devices.RP2Devices.RP2Device.getDocumentationUrl?4()
 eric7.MicroPython.Devices.RP2Devices.RP2Device.getDownloadMenuEntries?4()
 eric7.MicroPython.Devices.RP2Devices.RP2Device.getEthernetStatus?4()
+eric7.MicroPython.Devices.RP2Devices.RP2Device.getSecurityModes?4()
 eric7.MicroPython.Devices.RP2Devices.RP2Device.getWifiData?4()
 eric7.MicroPython.Devices.RP2Devices.RP2Device.hasBluetooth?4()
 eric7.MicroPython.Devices.RP2Devices.RP2Device.hasEthernet?4()
@@ -3452,7 +3455,7 @@
 eric7.MicroPython.WifiDialogs.WifiApConfigDialog.WifiApConfigDialog.accept?4()
 eric7.MicroPython.WifiDialogs.WifiApConfigDialog.WifiApConfigDialog.getApConfig?4()
 eric7.MicroPython.WifiDialogs.WifiApConfigDialog.WifiApConfigDialog.on_apShowPasswordButton_clicked?4(checked)
-eric7.MicroPython.WifiDialogs.WifiApConfigDialog.WifiApConfigDialog?1(withIP, parent=None)
+eric7.MicroPython.WifiDialogs.WifiApConfigDialog.WifiApConfigDialog?1(withIP, securityModes, parent=None)
 eric7.MicroPython.WifiDialogs.WifiApStationsDialog.WifiApStationsDialog?1(stations, parent=None)
 eric7.MicroPython.WifiDialogs.WifiConnectionDialog.WifiConnectionDialog.accept?4()
 eric7.MicroPython.WifiDialogs.WifiConnectionDialog.WifiConnectionDialog.getConnectionParameters?4()
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Sat Apr 26 11:58:15 2025 +0200
+++ b/src/eric7/Documentation/Help/source.qhp	Sat Apr 26 11:58:29 2025 +0200
@@ -2230,6 +2230,7 @@
       <keyword name="BaseDevice.getFirmwareUrl" id="BaseDevice.getFirmwareUrl" ref="eric7.MicroPython.Devices.DeviceBase.html#BaseDevice.getFirmwareUrl" />
       <keyword name="BaseDevice.getLibPaths" id="BaseDevice.getLibPaths" ref="eric7.MicroPython.Devices.DeviceBase.html#BaseDevice.getLibPaths" />
       <keyword name="BaseDevice.getModules" id="BaseDevice.getModules" ref="eric7.MicroPython.Devices.DeviceBase.html#BaseDevice.getModules" />
+      <keyword name="BaseDevice.getSecurityModes" id="BaseDevice.getSecurityModes" ref="eric7.MicroPython.Devices.DeviceBase.html#BaseDevice.getSecurityModes" />
       <keyword name="BaseDevice.getTime" id="BaseDevice.getTime" ref="eric7.MicroPython.Devices.DeviceBase.html#BaseDevice.getTime" />
       <keyword name="BaseDevice.getWifiData" id="BaseDevice.getWifiData" ref="eric7.MicroPython.Devices.DeviceBase.html#BaseDevice.getWifiData" />
       <keyword name="BaseDevice.getWorkspace" id="BaseDevice.getWorkspace" ref="eric7.MicroPython.Devices.DeviceBase.html#BaseDevice.getWorkspace" />
@@ -3080,6 +3081,7 @@
       <keyword name="CircuitPythonDevice.getDocumentationUrl" id="CircuitPythonDevice.getDocumentationUrl" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.getDocumentationUrl" />
       <keyword name="CircuitPythonDevice.getDownloadMenuEntries" id="CircuitPythonDevice.getDownloadMenuEntries" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.getDownloadMenuEntries" />
       <keyword name="CircuitPythonDevice.getEthernetStatus" id="CircuitPythonDevice.getEthernetStatus" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.getEthernetStatus" />
+      <keyword name="CircuitPythonDevice.getSecurityModes" id="CircuitPythonDevice.getSecurityModes" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.getSecurityModes" />
       <keyword name="CircuitPythonDevice.getWifiData" id="CircuitPythonDevice.getWifiData" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.getWifiData" />
       <keyword name="CircuitPythonDevice.getWorkspace" id="CircuitPythonDevice.getWorkspace" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.getWorkspace" />
       <keyword name="CircuitPythonDevice.hasBluetooth" id="CircuitPythonDevice.hasBluetooth" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.hasBluetooth" />
@@ -14610,6 +14612,7 @@
       <keyword name="RP2Device.getDocumentationUrl" id="RP2Device.getDocumentationUrl" ref="eric7.MicroPython.Devices.RP2Devices.html#RP2Device.getDocumentationUrl" />
       <keyword name="RP2Device.getDownloadMenuEntries" id="RP2Device.getDownloadMenuEntries" ref="eric7.MicroPython.Devices.RP2Devices.html#RP2Device.getDownloadMenuEntries" />
       <keyword name="RP2Device.getEthernetStatus" id="RP2Device.getEthernetStatus" ref="eric7.MicroPython.Devices.RP2Devices.html#RP2Device.getEthernetStatus" />
+      <keyword name="RP2Device.getSecurityModes" id="RP2Device.getSecurityModes" ref="eric7.MicroPython.Devices.RP2Devices.html#RP2Device.getSecurityModes" />
       <keyword name="RP2Device.getWifiData" id="RP2Device.getWifiData" ref="eric7.MicroPython.Devices.RP2Devices.html#RP2Device.getWifiData" />
       <keyword name="RP2Device.hasBluetooth" id="RP2Device.hasBluetooth" ref="eric7.MicroPython.Devices.RP2Devices.html#RP2Device.hasBluetooth" />
       <keyword name="RP2Device.hasEthernet" id="RP2Device.hasEthernet" ref="eric7.MicroPython.Devices.RP2Devices.html#RP2Device.hasEthernet" />
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html	Sat Apr 26 11:58:15 2025 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html	Sat Apr 26 11:58:29 2025 +0200
@@ -227,6 +227,10 @@
 <td>Public method to get Ethernet status data of the connected board.</td>
 </tr>
 <tr>
+<td><a href="#CircuitPythonDevice.getSecurityModes">getSecurityModes</a></td>
+<td>Public method to get a list of security modes supported by the device.</td>
+</tr>
+<tr>
 <td><a href="#CircuitPythonDevice.getWifiData">getWifiData</a></td>
 <td>Public method to get data related to the current WiFi status.</td>
 </tr>
@@ -1136,6 +1140,25 @@
 raised to indicate an issue with the device
 </dd>
 </dl>
+<a NAME="CircuitPythonDevice.getSecurityModes" ID="CircuitPythonDevice.getSecurityModes"></a>
+<h4>CircuitPythonDevice.getSecurityModes</h4>
+<b>getSecurityModes</b>(<i></i>)
+<p>
+        Public method to get a list of security modes supported by the device.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of supported security modes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
 <a NAME="CircuitPythonDevice.getWifiData" ID="CircuitPythonDevice.getWifiData"></a>
 <h4>CircuitPythonDevice.getWifiData</h4>
 <b>getWifiData</b>(<i></i>)
@@ -1539,9 +1562,9 @@
 <dd>
 SSID of the access point
 </dd>
-<dt><i>security</i> (int (optional))</dt>
+<dt><i>security</i> (str (optional))</dt>
 <dd>
-security method (defaults to None)
+security mode (defaults to None) (unused)
 </dd>
 <dt><i>password</i> (str (optional))</dt>
 <dd>
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Sat Apr 26 11:58:15 2025 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Sat Apr 26 11:58:29 2025 +0200
@@ -96,6 +96,9 @@
     <li>startAccessPoint: start an access point</li>
     <li>stopAccessPoint: stop the access point</li>
     <li>getConnectedClients: get a list of connected WiFi clients</li>
+    <li>getSecurityModes: get a list of supported security modes</li>
+    <li>enableWebrepl
+    <li>disableWebrepl
     </ul>
 </p>
 <p>
@@ -244,7 +247,7 @@
 </tr>
 <tr>
 <td><a href="#BaseDevice.disableWebrepl">disableWebrepl</a></td>
-<td>Public method to write the given WebREPL password to the connected device and modify the start script to start the WebREPL server.</td>
+<td>Public method to modify the start script to not start the WebREPL server.</td>
 </tr>
 <tr>
 <td><a href="#BaseDevice.disconnectFromLan">disconnectFromLan</a></td>
@@ -339,6 +342,10 @@
 <td>Public method to show a list of modules built into the firmware.</td>
 </tr>
 <tr>
+<td><a href="#BaseDevice.getSecurityModes">getSecurityModes</a></td>
+<td>Public method to get a list of security modes supported by the device.</td>
+</tr>
+<tr>
 <td><a href="#BaseDevice.getTime">getTime</a></td>
 <td>Public method to get the current time of the device.</td>
 </tr>
@@ -1140,8 +1147,7 @@
 <h4>BaseDevice.disableWebrepl</h4>
 <b>disableWebrepl</b>(<i></i>)
 <p>
-        Public method to write the given WebREPL password to the connected device and
-        modify the start script to start the WebREPL server.
+        Public method to modify the start script to not start the WebREPL server.
 </p>
 
 <dl>
@@ -1703,6 +1709,25 @@
 raised to indicate an issue with the device
 </dd>
 </dl>
+<a NAME="BaseDevice.getSecurityModes" ID="BaseDevice.getSecurityModes"></a>
+<h4>BaseDevice.getSecurityModes</h4>
+<b>getSecurityModes</b>(<i></i>)
+<p>
+        Public method to get a list of security modes supported by the device.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of supported security modes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
 <a NAME="BaseDevice.getTime" ID="BaseDevice.getTime"></a>
 <h4>BaseDevice.getTime</h4>
 <b>getTime</b>(<i></i>)
@@ -2707,9 +2732,9 @@
 <dd>
 SSID of the access point (unused)
 </dd>
-<dt><i>security</i> (int (optional))</dt>
+<dt><i>security</i> (str (optional))</dt>
 <dd>
-security method (defaults to None) (unused)
+security mode (defaults to None) (unused)
 </dd>
 <dt><i>password</i> (str (optional))</dt>
 <dd>
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html	Sat Apr 26 11:58:15 2025 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html	Sat Apr 26 11:58:29 2025 +0200
@@ -1254,9 +1254,9 @@
 <dd>
 SSID of the access point
 </dd>
-<dt><i>security</i> (int (optional))</dt>
+<dt><i>security</i> (str (optional))</dt>
 <dd>
-security method (defaults to None)
+security mode (defaults to None) (unused)
 </dd>
 <dt><i>password</i> (str (optional))</dt>
 <dd>
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2Devices.html	Sat Apr 26 11:58:15 2025 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2Devices.html	Sat Apr 26 11:58:29 2025 +0200
@@ -204,6 +204,10 @@
 <td>Public method to get Ethernet status data of the connected board.</td>
 </tr>
 <tr>
+<td><a href="#RP2Device.getSecurityModes">getSecurityModes</a></td>
+<td>Public method to get a list of security modes supported by the device.</td>
+</tr>
+<tr>
 <td><a href="#RP2Device.getWifiData">getWifiData</a></td>
 <td>Public method to get data related to the current WiFi status.</td>
 </tr>
@@ -1022,6 +1026,25 @@
 raised to indicate an issue with the device
 </dd>
 </dl>
+<a NAME="RP2Device.getSecurityModes" ID="RP2Device.getSecurityModes"></a>
+<h4>RP2Device.getSecurityModes</h4>
+<b>getSecurityModes</b>(<i></i>)
+<p>
+        Public method to get a list of security modes supported by the device.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of supported security modes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
 <a NAME="RP2Device.getWifiData" ID="RP2Device.getWifiData"></a>
 <h4>RP2Device.getWifiData</h4>
 <b>getWifiData</b>(<i></i>)
@@ -1382,9 +1405,9 @@
 <dd>
 SSID of the access point
 </dd>
-<dt><i>security</i> (int (optional))</dt>
+<dt><i>security</i> (str (optional))</dt>
 <dd>
-security method (defaults to None)
+security mode (defaults to None) (unused)
 </dd>
 <dt><i>password</i> (str (optional))</dt>
 <dd>
--- a/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiApConfigDialog.html	Sat Apr 26 11:58:15 2025 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiApConfigDialog.html	Sat Apr 26 11:58:29 2025 +0200
@@ -81,7 +81,7 @@
 
 <a NAME="WifiApConfigDialog.__init__" ID="WifiApConfigDialog.__init__"></a>
 <h4>WifiApConfigDialog (Constructor)</h4>
-<b>WifiApConfigDialog</b>(<i>withIP, parent=None</i>)
+<b>WifiApConfigDialog</b>(<i>withIP, securityModes, parent=None</i>)
 <p>
         Constructor
 </p>
@@ -92,6 +92,10 @@
 <dd>
 flag indicating to ask the user for an IP configuration
 </dd>
+<dt><i>securityModes</i> (list of str)</dt>
+<dd>
+list of supported security modes
+</dd>
 <dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
 reference to the parent widget (defaults to None)

eric ide

mercurial