--- a/src/eric7/Documentation/Source/eric7.Globals.__init__.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.Globals.__init__.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,24 +7,38 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.Globals.__init__</h1> - <p> Module defining common data to be used by all modules. </p> + <h3>Global Attributes</h3> - <table> -<tr><td>configDir</td></tr><tr><td>recentNameBreakpointConditions</td></tr><tr><td>recentNameBreakpointFiles</td></tr><tr><td>recentNameFiles</td></tr><tr><td>recentNameHexFiles</td></tr><tr><td>recentNameHosts</td></tr><tr><td>recentNameMultiProject</td></tr><tr><td>recentNamePdfFiles</td></tr><tr><td>recentNameProject</td></tr><tr><td>recentNameTestDiscoverHistory</td></tr><tr><td>recentNameTestEnvironment</td></tr><tr><td>recentNameTestFileHistory</td></tr><tr><td>recentNameTestFramework</td></tr><tr><td>recentNameTestNameHistory</td></tr><tr><td>settingsNameGlobal</td></tr><tr><td>settingsNameOrganization</td></tr><tr><td>settingsNameRecent</td></tr> +<tr><td>configDir</td></tr> +<tr><td>recentNameBreakpointConditions</td></tr> +<tr><td>recentNameBreakpointFiles</td></tr> +<tr><td>recentNameFiles</td></tr> +<tr><td>recentNameHexFiles</td></tr> +<tr><td>recentNameHosts</td></tr> +<tr><td>recentNameMultiProject</td></tr> +<tr><td>recentNamePdfFiles</td></tr> +<tr><td>recentNameProject</td></tr> +<tr><td>recentNameTestDiscoverHistory</td></tr> +<tr><td>recentNameTestEnvironment</td></tr> +<tr><td>recentNameTestFileHistory</td></tr> +<tr><td>recentNameTestFramework</td></tr> +<tr><td>recentNameTestNameHistory</td></tr> +<tr><td>settingsNameGlobal</td></tr> +<tr><td>settingsNameOrganization</td></tr> +<tr><td>settingsNameRecent</td></tr> </table> + <h3>Classes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#dataString">dataString</a></td> <td>Module function to generate a formatted size string.</td> @@ -78,15 +92,16 @@ <td>Module function to convert a version string into a tuple.</td> </tr> </table> + <hr /> <hr /> <a NAME="dataString" ID="dataString"></a> <h2>dataString</h2> <b>dataString</b>(<i>size, loc=None</i>) - <p> Module function to generate a formatted size string. </p> + <dl> <dt><i>size</i> (int)</dt> @@ -116,10 +131,10 @@ <a NAME="getConfigDir" ID="getConfigDir"></a> <h2>getConfigDir</h2> <b>getConfigDir</b>(<i></i>) - <p> Module function to get the name of the directory storing the config data. </p> + <dl> <dt>Return:</dt> <dd> @@ -138,10 +153,10 @@ <a NAME="getInstallInfoFilePath" ID="getInstallInfoFilePath"></a> <h2>getInstallInfoFilePath</h2> <b>getInstallInfoFilePath</b>(<i></i>) - <p> Public method to get the path name of the install info file. </p> + <dl> <dt>Return:</dt> <dd> @@ -160,10 +175,10 @@ <a NAME="getWebBrowserSupport" ID="getWebBrowserSupport"></a> <h2>getWebBrowserSupport</h2> <b>getWebBrowserSupport</b>(<i></i>) - <p> Module function to determine the supported web browser variant. </p> + <dl> <dt>Return:</dt> <dd> @@ -183,10 +198,10 @@ <a NAME="setConfigDir" ID="setConfigDir"></a> <h2>setConfigDir</h2> <b>setConfigDir</b>(<i>d</i>) - <p> Module function to set the name of the directory storing the config data. </p> + <dl> <dt><i>d</i> (str)</dt> @@ -200,11 +215,11 @@ <a NAME="strGroup" ID="strGroup"></a> <h2>strGroup</h2> <b>strGroup</b>(<i>txt, sep, groupLen=4</i>) - <p> Module function to group a string into sub-strings separated by a separator. </p> + <dl> <dt><i>txt</i> (str)</dt> @@ -238,10 +253,10 @@ <a NAME="strToQByteArray" ID="strToQByteArray"></a> <h2>strToQByteArray</h2> <b>strToQByteArray</b>(<i>txt</i>) - <p> Module function to convert a Python string into a QByteArray. </p> + <dl> <dt><i>txt</i> (str, bytes, bytearray)</dt> @@ -267,10 +282,10 @@ <a NAME="toBool" ID="toBool"></a> <h2>toBool</h2> <b>toBool</b>(<i>value</i>) - <p> Module function to convert a value to bool. </p> + <dl> <dt><i>value</i> (str)</dt> @@ -296,10 +311,10 @@ <a NAME="toByteArray" ID="toByteArray"></a> <h2>toByteArray</h2> <b>toByteArray</b>(<i>value</i>) - <p> Module function to convert a value to a byte array. </p> + <dl> <dt><i>value</i> (QByteArray or None)</dt> @@ -325,10 +340,10 @@ <a NAME="toDict" ID="toDict"></a> <h2>toDict</h2> <b>toDict</b>(<i>value</i>) - <p> Module function to convert a value to a dictionary. </p> + <dl> <dt><i>value</i> (dict or None)</dt> @@ -354,10 +369,10 @@ <a NAME="toList" ID="toList"></a> <h2>toList</h2> <b>toList</b>(<i>value</i>) - <p> Module function to convert a value to a list. </p> + <dl> <dt><i>value</i> (None, list or Any)</dt> @@ -383,10 +398,10 @@ <a NAME="versionIsValid" ID="versionIsValid"></a> <h2>versionIsValid</h2> <b>versionIsValid</b>(<i>version</i>) - <p> Function to check, if the given version string is valid. </p> + <dl> <dt><i>version</i> (str)</dt> @@ -412,7 +427,6 @@ <a NAME="versionToTuple" ID="versionToTuple"></a> <h2>versionToTuple</h2> <b>versionToTuple</b>(<i>version</i>) - <p> Module function to convert a version string into a tuple. </p> @@ -421,6 +435,7 @@ optionally followed by a suffix. Suffix is everything after the last decimal. </p> + <dl> <dt><i>version</i> (str)</dt> @@ -442,4 +457,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>