Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax.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.yamlCheckSyntax</h1> | 9 <h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the syntax check for YAML. | 11 Module implementing the syntax check for YAML. |
| 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="#__yamlSyntaxCheck">__yamlSyntaxCheck</a></td> | 27 <td><a href="#__yamlSyntaxCheck">__yamlSyntaxCheck</a></td> |
| 30 <td>Function to check a YAML source file for syntax errors.</td> | 28 <td>Function to check a YAML source file for syntax errors.</td> |
| 31 </tr> | 29 </tr> |
| 32 <tr> | 30 <tr> |
| 48 <tr> | 46 <tr> |
| 49 <td><a href="#yamlSyntaxCheck">yamlSyntaxCheck</a></td> | 47 <td><a href="#yamlSyntaxCheck">yamlSyntaxCheck</a></td> |
| 50 <td>Function to check a YAML source file for syntax errors.</td> | 48 <td>Function to check a YAML source file for syntax errors.</td> |
| 51 </tr> | 49 </tr> |
| 52 </table> | 50 </table> |
| 51 | |
| 53 <hr /> | 52 <hr /> |
| 54 <hr /> | 53 <hr /> |
| 55 <a NAME="__yamlSyntaxCheck" ID="__yamlSyntaxCheck"></a> | 54 <a NAME="__yamlSyntaxCheck" ID="__yamlSyntaxCheck"></a> |
| 56 <h2>__yamlSyntaxCheck</h2> | 55 <h2>__yamlSyntaxCheck</h2> |
| 57 <b>__yamlSyntaxCheck</b>(<i>file, codestring</i>) | 56 <b>__yamlSyntaxCheck</b>(<i>file, codestring</i>) |
| 58 | |
| 59 <p> | 57 <p> |
| 60 Function to check a YAML source file for syntax errors. | 58 Function to check a YAML 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="workerTask" ID="workerTask"></a> | 133 <a NAME="workerTask" ID="workerTask"></a> |
| 135 <h2>workerTask</h2> | 134 <h2>workerTask</h2> |
| 136 <b>workerTask</b>(<i>inputQueue, outputQueue</i>) | 135 <b>workerTask</b>(<i>inputQueue, outputQueue</i>) |
| 137 | |
| 138 <p> | 136 <p> |
| 139 Module function acting as the parallel worker for the syntax check. | 137 Module function acting as the parallel worker for the syntax check. |
| 140 </p> | 138 </p> |
| 139 | |
| 141 <dl> | 140 <dl> |
| 142 | 141 |
| 143 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> | 142 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> |
| 144 <dd> | 143 <dd> |
| 145 input queue | 144 input queue |
| 153 <hr /> | 152 <hr /> |
| 154 <hr /> | 153 <hr /> |
| 155 <a NAME="yamlSyntaxBatchCheck" ID="yamlSyntaxBatchCheck"></a> | 154 <a NAME="yamlSyntaxBatchCheck" ID="yamlSyntaxBatchCheck"></a> |
| 156 <h2>yamlSyntaxBatchCheck</h2> | 155 <h2>yamlSyntaxBatchCheck</h2> |
| 157 <b>yamlSyntaxBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) | 156 <b>yamlSyntaxBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) |
| 158 | |
| 159 <p> | 157 <p> |
| 160 Module function to check syntax for a batch of files. | 158 Module function to check syntax for a batch of files. |
| 161 </p> | 159 </p> |
| 160 | |
| 162 <dl> | 161 <dl> |
| 163 | 162 |
| 164 <dt><i>argumentsList</i> (list)</dt> | 163 <dt><i>argumentsList</i> (list)</dt> |
| 165 <dd> | 164 <dd> |
| 166 list of arguments tuples as given for yamlSyntaxCheck | 165 list of arguments tuples as given for yamlSyntaxCheck |
| 186 <hr /> | 185 <hr /> |
| 187 <hr /> | 186 <hr /> |
| 188 <a NAME="yamlSyntaxCheck" ID="yamlSyntaxCheck"></a> | 187 <a NAME="yamlSyntaxCheck" ID="yamlSyntaxCheck"></a> |
| 189 <h2>yamlSyntaxCheck</h2> | 188 <h2>yamlSyntaxCheck</h2> |
| 190 <b>yamlSyntaxCheck</b>(<i>file, codestring</i>) | 189 <b>yamlSyntaxCheck</b>(<i>file, codestring</i>) |
| 191 | |
| 192 <p> | 190 <p> |
| 193 Function to check a YAML source file for syntax errors. | 191 Function to check a YAML source file for syntax errors. |
| 194 </p> | 192 </p> |
| 193 | |
| 195 <dl> | 194 <dl> |
| 196 | 195 |
| 197 <dt><i>file</i> (str)</dt> | 196 <dt><i>file</i> (str)</dt> |
| 198 <dd> | 197 <dd> |
| 199 source filename | 198 source filename |
