32 <tr><td>None</td></tr> |
32 <tr><td>None</td></tr> |
33 </table> |
33 </table> |
34 <h3>Functions</h3> |
34 <h3>Functions</h3> |
35 <table> |
35 <table> |
36 <tr> |
36 <tr> |
|
37 <td><a href="#__jsSyntaxCheck">__jsSyntaxCheck</a></td> |
|
38 <td>Function to check a Javascript source file for syntax errors.</td> |
|
39 </tr><tr> |
|
40 <td><a href="#initBatchService">initBatchService</a></td> |
|
41 <td>Initialize the batch service and return the entry point.</td> |
|
42 </tr><tr> |
37 <td><a href="#initService">initService</a></td> |
43 <td><a href="#initService">initService</a></td> |
38 <td>Initialize the service and return the entry point.</td> |
44 <td>Initialize the service and return the entry point.</td> |
39 </tr><tr> |
45 </tr><tr> |
40 <td><a href="#jsCheckSyntax">jsCheckSyntax</a></td> |
46 <td><a href="#jsSyntaxBatchCheck">jsSyntaxBatchCheck</a></td> |
|
47 <td>Module function to check syntax for a batch of files.</td> |
|
48 </tr><tr> |
|
49 <td><a href="#jsSyntaxCheck">jsSyntaxCheck</a></td> |
41 <td>Function to check a Javascript source file for syntax errors.</td> |
50 <td>Function to check a Javascript source file for syntax errors.</td> |
42 </tr><tr> |
51 </tr><tr> |
43 <td><a href="#normalizeCode">normalizeCode</a></td> |
52 <td><a href="#normalizeCode">normalizeCode</a></td> |
44 <td>Function to normalize the given code.</td> |
53 <td>Function to normalize the given code.</td> |
|
54 </tr><tr> |
|
55 <td><a href="#worker">worker</a></td> |
|
56 <td>Module function acting as the parallel worker for the style check.</td> |
45 </tr> |
57 </tr> |
46 </table> |
58 </table> |
|
59 <hr /><hr /> |
|
60 <a NAME="__jsSyntaxCheck" ID="__jsSyntaxCheck"></a> |
|
61 <h2>__jsSyntaxCheck</h2> |
|
62 <b>__jsSyntaxCheck</b>(<i>file, codestring</i>) |
|
63 <p> |
|
64 Function to check a Javascript source file for syntax errors. |
|
65 </p><dl> |
|
66 <dt><i>file</i></dt> |
|
67 <dd> |
|
68 source filename (string) |
|
69 </dd><dt><i>codestring</i></dt> |
|
70 <dd> |
|
71 string containing the code to check (string) |
|
72 </dd> |
|
73 </dl><dl> |
|
74 <dt>Returns:</dt> |
|
75 <dd> |
|
76 dictionary with the keys 'error' and 'warnings' which |
|
77 hold a list containing details about the error/ warnings |
|
78 (file name, line number, column, codestring (only at syntax |
|
79 errors), the message, a list with arguments for the message) |
|
80 </dd> |
|
81 </dl> |
|
82 <div align="right"><a href="#top">Up</a></div> |
|
83 <hr /><hr /> |
|
84 <a NAME="initBatchService" ID="initBatchService"></a> |
|
85 <h2>initBatchService</h2> |
|
86 <b>initBatchService</b>(<i></i>) |
|
87 <p> |
|
88 Initialize the batch service and return the entry point. |
|
89 </p><dl> |
|
90 <dt>Returns:</dt> |
|
91 <dd> |
|
92 the entry point for the background client (function) |
|
93 </dd> |
|
94 </dl> |
|
95 <div align="right"><a href="#top">Up</a></div> |
47 <hr /><hr /> |
96 <hr /><hr /> |
48 <a NAME="initService" ID="initService"></a> |
97 <a NAME="initService" ID="initService"></a> |
49 <h2>initService</h2> |
98 <h2>initService</h2> |
50 <b>initService</b>(<i></i>) |
99 <b>initService</b>(<i></i>) |
51 <p> |
100 <p> |
56 the entry point for the background client (function) |
105 the entry point for the background client (function) |
57 </dd> |
106 </dd> |
58 </dl> |
107 </dl> |
59 <div align="right"><a href="#top">Up</a></div> |
108 <div align="right"><a href="#top">Up</a></div> |
60 <hr /><hr /> |
109 <hr /><hr /> |
61 <a NAME="jsCheckSyntax" ID="jsCheckSyntax"></a> |
110 <a NAME="jsSyntaxBatchCheck" ID="jsSyntaxBatchCheck"></a> |
62 <h2>jsCheckSyntax</h2> |
111 <h2>jsSyntaxBatchCheck</h2> |
63 <b>jsCheckSyntax</b>(<i>file, codestring</i>) |
112 <b>jsSyntaxBatchCheck</b>(<i>argumentsList, send, fx, cancelled</i>) |
|
113 <p> |
|
114 Module function to check syntax for a batch of files. |
|
115 </p><dl> |
|
116 <dt><i>argumentsList</i></dt> |
|
117 <dd> |
|
118 list of arguments tuples as given for |
|
119 syntaxAndPyflakesCheck |
|
120 </dd><dt><i>send</i></dt> |
|
121 <dd> |
|
122 reference to send function (function) |
|
123 </dd><dt><i>fx</i></dt> |
|
124 <dd> |
|
125 registered service name (string) |
|
126 </dd><dt><i>cancelled</i></dt> |
|
127 <dd> |
|
128 reference to function checking for a cancellation |
|
129 (function) |
|
130 </dd> |
|
131 </dl> |
|
132 <div align="right"><a href="#top">Up</a></div> |
|
133 <hr /><hr /> |
|
134 <a NAME="jsSyntaxCheck" ID="jsSyntaxCheck"></a> |
|
135 <h2>jsSyntaxCheck</h2> |
|
136 <b>jsSyntaxCheck</b>(<i>file, codestring</i>) |
64 <p> |
137 <p> |
65 Function to check a Javascript source file for syntax errors. |
138 Function to check a Javascript source file for syntax errors. |
66 </p><dl> |
139 </p><dl> |
67 <dt><i>file</i></dt> |
140 <dt><i>file</i></dt> |
68 <dd> |
141 <dd> |
97 <dd> |
170 <dd> |
98 normalized code (string) |
171 normalized code (string) |
99 </dd> |
172 </dd> |
100 </dl> |
173 </dl> |
101 <div align="right"><a href="#top">Up</a></div> |
174 <div align="right"><a href="#top">Up</a></div> |
|
175 <hr /><hr /> |
|
176 <a NAME="worker" ID="worker"></a> |
|
177 <h2>worker</h2> |
|
178 <b>worker</b>(<i>input, output</i>) |
|
179 <p> |
|
180 Module function acting as the parallel worker for the style check. |
|
181 </p><dl> |
|
182 <dt><i>input</i></dt> |
|
183 <dd> |
|
184 input queue (multiprocessing.Queue) |
|
185 </dd><dt><i>output</i></dt> |
|
186 <dd> |
|
187 output queue (multiprocessing.Queue) |
|
188 </dd> |
|
189 </dl> |
|
190 <div align="right"><a href="#top">Up</a></div> |
102 <hr /> |
191 <hr /> |
103 </body></html> |
192 </body></html> |