Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.tomlCheckSyntax.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.tomlCheckSyntax.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10341
- 3fdffd9cc21d
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.tomlCheckSyntax</h1> | 9 <h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.tomlCheckSyntax</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the syntax check for TOML. | 11 Module implementing the syntax check for TOML. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 <tr><td>None</td></tr> | 21 <tr><td>None</td></tr> |
| 23 </table> | 22 </table> |
| 23 | |
| 24 <h3>Functions</h3> | 24 <h3>Functions</h3> |
| 25 | |
| 26 <table> | 25 <table> |
| 27 | |
| 28 <tr> | 26 <tr> |
| 29 <td><a href="#__tomlSyntaxCheck">__tomlSyntaxCheck</a></td> | 27 <td><a href="#__tomlSyntaxCheck">__tomlSyntaxCheck</a></td> |
| 30 <td>Function to check a TOML source file for syntax errors.</td> | 28 <td>Function to check a TOML source file for syntax errors.</td> |
| 31 </tr> | 29 </tr> |
| 32 <tr> | 30 <tr> |
| 48 <tr> | 46 <tr> |
| 49 <td><a href="#workerTask">workerTask</a></td> | 47 <td><a href="#workerTask">workerTask</a></td> |
| 50 <td>Module function acting as the parallel worker for the syntax check.</td> | 48 <td>Module function acting as the parallel worker for the syntax check.</td> |
| 51 </tr> | 49 </tr> |
| 52 </table> | 50 </table> |
| 51 | |
| 53 <hr /> | 52 <hr /> |
| 54 <hr /> | 53 <hr /> |
| 55 <a NAME="__tomlSyntaxCheck" ID="__tomlSyntaxCheck"></a> | 54 <a NAME="__tomlSyntaxCheck" ID="__tomlSyntaxCheck"></a> |
| 56 <h2>__tomlSyntaxCheck</h2> | 55 <h2>__tomlSyntaxCheck</h2> |
| 57 <b>__tomlSyntaxCheck</b>(<i>file, codestring</i>) | 56 <b>__tomlSyntaxCheck</b>(<i>file, codestring</i>) |
| 58 | |
| 59 <p> | 57 <p> |
| 60 Function to check a TOML source file for syntax errors. | 58 Function to check a TOML source file for syntax errors. |
| 61 </p> | 59 </p> |
| 60 | |
| 62 <dl> | 61 <dl> |
| 63 | 62 |
| 64 <dt><i>file</i> (str)</dt> | 63 <dt><i>file</i> (str)</dt> |
| 65 <dd> | 64 <dd> |
| 66 source filename | 65 source filename |
| 88 <hr /> | 87 <hr /> |
| 89 <hr /> | 88 <hr /> |
| 90 <a NAME="initBatchService" ID="initBatchService"></a> | 89 <a NAME="initBatchService" ID="initBatchService"></a> |
| 91 <h2>initBatchService</h2> | 90 <h2>initBatchService</h2> |
| 92 <b>initBatchService</b>(<i></i>) | 91 <b>initBatchService</b>(<i></i>) |
| 93 | |
| 94 <p> | 92 <p> |
| 95 Initialize the batch service and return the entry point. | 93 Initialize the batch service and return the entry point. |
| 96 </p> | 94 </p> |
| 95 | |
| 97 <dl> | 96 <dl> |
| 98 <dt>Return:</dt> | 97 <dt>Return:</dt> |
| 99 <dd> | 98 <dd> |
| 100 the entry point for the background client | 99 the entry point for the background client |
| 101 </dd> | 100 </dd> |
| 110 <hr /> | 109 <hr /> |
| 111 <hr /> | 110 <hr /> |
| 112 <a NAME="initService" ID="initService"></a> | 111 <a NAME="initService" ID="initService"></a> |
| 113 <h2>initService</h2> | 112 <h2>initService</h2> |
| 114 <b>initService</b>(<i></i>) | 113 <b>initService</b>(<i></i>) |
| 115 | |
| 116 <p> | 114 <p> |
| 117 Initialize the service and return the entry point. | 115 Initialize the service and return the entry point. |
| 118 </p> | 116 </p> |
| 117 | |
| 119 <dl> | 118 <dl> |
| 120 <dt>Return:</dt> | 119 <dt>Return:</dt> |
| 121 <dd> | 120 <dd> |
| 122 the entry point for the background client | 121 the entry point for the background client |
| 123 </dd> | 122 </dd> |
| 132 <hr /> | 131 <hr /> |
| 133 <hr /> | 132 <hr /> |
| 134 <a NAME="tomlSyntaxBatchCheck" ID="tomlSyntaxBatchCheck"></a> | 133 <a NAME="tomlSyntaxBatchCheck" ID="tomlSyntaxBatchCheck"></a> |
| 135 <h2>tomlSyntaxBatchCheck</h2> | 134 <h2>tomlSyntaxBatchCheck</h2> |
| 136 <b>tomlSyntaxBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) | 135 <b>tomlSyntaxBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) |
| 137 | |
| 138 <p> | 136 <p> |
| 139 Module function to check syntax for a batch of files. | 137 Module function to check syntax for a batch of files. |
| 140 </p> | 138 </p> |
| 139 | |
| 141 <dl> | 140 <dl> |
| 142 | 141 |
| 143 <dt><i>argumentsList</i> (list)</dt> | 142 <dt><i>argumentsList</i> (list)</dt> |
| 144 <dd> | 143 <dd> |
| 145 list of arguments tuples as given for tomlSyntaxCheck | 144 list of arguments tuples as given for tomlSyntaxCheck |
| 165 <hr /> | 164 <hr /> |
| 166 <hr /> | 165 <hr /> |
| 167 <a NAME="tomlSyntaxCheck" ID="tomlSyntaxCheck"></a> | 166 <a NAME="tomlSyntaxCheck" ID="tomlSyntaxCheck"></a> |
| 168 <h2>tomlSyntaxCheck</h2> | 167 <h2>tomlSyntaxCheck</h2> |
| 169 <b>tomlSyntaxCheck</b>(<i>file, codestring</i>) | 168 <b>tomlSyntaxCheck</b>(<i>file, codestring</i>) |
| 170 | |
| 171 <p> | 169 <p> |
| 172 Function to check a TOML source file for syntax errors. | 170 Function to check a TOML source file for syntax errors. |
| 173 </p> | 171 </p> |
| 172 | |
| 174 <dl> | 173 <dl> |
| 175 | 174 |
| 176 <dt><i>file</i> (str)</dt> | 175 <dt><i>file</i> (str)</dt> |
| 177 <dd> | 176 <dd> |
| 178 source filename | 177 source filename |
| 200 <hr /> | 199 <hr /> |
| 201 <hr /> | 200 <hr /> |
| 202 <a NAME="workerTask" ID="workerTask"></a> | 201 <a NAME="workerTask" ID="workerTask"></a> |
| 203 <h2>workerTask</h2> | 202 <h2>workerTask</h2> |
| 204 <b>workerTask</b>(<i>inputQueue, outputQueue</i>) | 203 <b>workerTask</b>(<i>inputQueue, outputQueue</i>) |
| 205 | |
| 206 <p> | 204 <p> |
| 207 Module function acting as the parallel worker for the syntax check. | 205 Module function acting as the parallel worker for the syntax check. |
| 208 </p> | 206 </p> |
| 207 | |
| 209 <dl> | 208 <dl> |
| 210 | 209 |
| 211 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> | 210 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> |
| 212 <dd> | 211 <dd> |
| 213 input queue | 212 input queue |
