src/eric7/Documentation/Source/eric7.DataViews.CodeMetrics.html

branch
eric7
changeset 10423
299802979277
parent 10229
e50bbf250343
child 10479
856476537696
equal deleted inserted replaced
10422:e28b89693f37 10423:299802979277
99 <p> 99 <p>
100 Private method used to add a token to our list of tokens. 100 Private method used to add a token to our list of tokens.
101 </p> 101 </p>
102 <dl> 102 <dl>
103 103
104 <dt><i>toktype</i></dt> 104 <dt><i>toktype</i> (int)</dt>
105 <dd> 105 <dd>
106 the type of the token (int) 106 the type of the token
107 </dd> 107 </dd>
108 <dt><i>toktext</i></dt> 108 <dt><i>toktext</i> (str)</dt>
109 <dd> 109 <dd>
110 the text of the token (string) 110 the text of the token
111 </dd> 111 </dd>
112 <dt><i>srow</i></dt> 112 <dt><i>srow</i> (int)</dt>
113 <dd> 113 <dd>
114 starting row of the token (int) 114 starting row of the token
115 </dd> 115 </dd>
116 <dt><i>scol</i></dt> 116 <dt><i>scol</i> (int)</dt>
117 <dd> 117 <dd>
118 starting column of the token (int) 118 starting column of the token
119 </dd> 119 </dd>
120 <dt><i>line</i></dt> 120 <dt><i>line</i> (str)</dt>
121 <dd> 121 <dd>
122 logical line the token was found (string) 122 logical line the token was found
123 </dd> 123 </dd>
124 </dl> 124 </dl>
125 <a NAME="Parser.parse" ID="Parser.parse"></a> 125 <a NAME="Parser.parse" ID="Parser.parse"></a>
126 <h4>Parser.parse</h4> 126 <h4>Parser.parse</h4>
127 <b>parse</b>(<i>text</i>) 127 <b>parse</b>(<i>text</i>)
129 <p> 129 <p>
130 Public method used to parse the source code. 130 Public method used to parse the source code.
131 </p> 131 </p>
132 <dl> 132 <dl>
133 133
134 <dt><i>text</i></dt> 134 <dt><i>text</i> (str)</dt>
135 <dd> 135 <dd>
136 the source code as read from a Python source file 136 source code as read from a Python source file
137 </dd> 137 </dd>
138 </dl> 138 </dl>
139 <div align="right"><a href="#top">Up</a></div> 139 <div align="right"><a href="#top">Up</a></div>
140 <hr /> 140 <hr />
141 <hr /> 141 <hr />
206 <p> 206 <p>
207 Public method used to decrement the indentation level. 207 Public method used to decrement the indentation level.
208 </p> 208 </p>
209 <dl> 209 <dl>
210 210
211 <dt><i>tok</i></dt> 211 <dt><i>tok</i> (Token)</dt>
212 <dd> 212 <dd>
213 the token to be processed (Token) 213 the token to be processed
214 </dd> 214 </dd>
215 </dl> 215 </dl>
216 <dl> 216 <dl>
217 217
218 <dt>Raises <b>ValueError</b>:</dt> 218 <dt>Raises <b>ValueError</b>:</dt>
227 <p> 227 <p>
228 Public method used to get a specific counter value. 228 Public method used to get a specific counter value.
229 </p> 229 </p>
230 <dl> 230 <dl>
231 231
232 <dt><i>counterId</i></dt> 232 <dt><i>counterId</i> (str)</dt>
233 <dd> 233 <dd>
234 id of the counter (string) 234 id of the counter
235 </dd> 235 </dd>
236 <dt><i>key</i></dt> 236 <dt><i>key</i> (str)</dt>
237 <dd> 237 <dd>
238 key of the value to be retrieved (string) 238 key of the value to be retrieved
239 </dd> 239 </dd>
240 </dl> 240 </dl>
241 <dl> 241 <dl>
242 <dt>Return:</dt> 242 <dt>Return:</dt>
243 <dd> 243 <dd>
244 the value of the requested counter (int) 244 the value of the requested counter
245 </dd>
246 </dl>
247 <dl>
248 <dt>Return Type:</dt>
249 <dd>
250 int
245 </dd> 251 </dd>
246 </dl> 252 </dl>
247 <a NAME="SourceStat.inc" ID="SourceStat.inc"></a> 253 <a NAME="SourceStat.inc" ID="SourceStat.inc"></a>
248 <h4>SourceStat.inc</h4> 254 <h4>SourceStat.inc</h4>
249 <b>inc</b>(<i>key, value=1</i>) 255 <b>inc</b>(<i>key, value=1</i>)
251 <p> 257 <p>
252 Public method used to increment the value of a key. 258 Public method used to increment the value of a key.
253 </p> 259 </p>
254 <dl> 260 <dl>
255 261
256 <dt><i>key</i></dt> 262 <dt><i>key</i> (str)</dt>
257 <dd> 263 <dd>
258 the key to be incremented 264 key to be incremented
259 </dd> 265 </dd>
260 <dt><i>value</i></dt> 266 <dt><i>value</i> (int)</dt>
261 <dd> 267 <dd>
262 the increment (int) 268 the increment
263 </dd> 269 </dd>
264 </dl> 270 </dl>
265 <a NAME="SourceStat.indent" ID="SourceStat.indent"></a> 271 <a NAME="SourceStat.indent" ID="SourceStat.indent"></a>
266 <h4>SourceStat.indent</h4> 272 <h4>SourceStat.indent</h4>
267 <b>indent</b>(<i></i>) 273 <b>indent</b>(<i></i>)
276 <p> 282 <p>
277 Public method used to store an identifier. 283 Public method used to store an identifier.
278 </p> 284 </p>
279 <dl> 285 <dl>
280 286
281 <dt><i>identifier</i></dt> 287 <dt><i>identifier</i> (str)</dt>
282 <dd> 288 <dd>
283 the identifier to be remembered (string) 289 the identifier to be remembered
284 </dd> 290 </dd>
285 <dt><i>row</i></dt> 291 <dt><i>row</i> (int)</dt>
286 <dd> 292 <dd>
287 the row, the identifier is defined in (int) 293 row, the identifier is defined in
288 </dd> 294 </dd>
289 </dl> 295 </dl>
290 <div align="right"><a href="#top">Up</a></div> 296 <div align="right"><a href="#top">Up</a></div>
291 <hr /> 297 <hr />
292 <hr /> 298 <hr />
329 <p> 335 <p>
330 Module function used analyze the source of a Python file. 336 Module function used analyze the source of a Python file.
331 </p> 337 </p>
332 <dl> 338 <dl>
333 339
334 <dt><i>filename</i></dt> 340 <dt><i>filename</i> (str)</dt>
335 <dd> 341 <dd>
336 name of the Python file to be analyzed (string) 342 name of the Python file to be analyzed
337 </dd> 343 </dd>
338 <dt><i>total</i></dt> 344 <dt><i>total</i> (dict)</dt>
339 <dd> 345 <dd>
340 dictionary receiving the overall code statistics 346 dictionary receiving the overall code statistics
341 </dd> 347 </dd>
342 </dl> 348 </dl>
343 <dl> 349 <dl>
344 <dt>Return:</dt> 350 <dt>Return:</dt>
345 <dd> 351 <dd>
346 a statistics object with the collected code statistics (SourceStat) 352 a statistics object with the collected code statistics
353 </dd>
354 </dl>
355 <dl>
356 <dt>Return Type:</dt>
357 <dd>
358 SourceStat
347 </dd> 359 </dd>
348 </dl> 360 </dl>
349 <div align="right"><a href="#top">Up</a></div> 361 <div align="right"><a href="#top">Up</a></div>
350 <hr /> 362 <hr />
351 <hr /> 363 <hr />
356 <p> 368 <p>
357 Module function used to collect overall statistics. 369 Module function used to collect overall statistics.
358 </p> 370 </p>
359 <dl> 371 <dl>
360 372
361 <dt><i>total</i></dt> 373 <dt><i>total</i> (dict)</dt>
362 <dd> 374 <dd>
363 the dictionary for the overall statistics 375 dictionary of overall statistics
364 </dd> 376 </dd>
365 <dt><i>key</i></dt> 377 <dt><i>key</i> (str)</dt>
366 <dd> 378 <dd>
367 the key to be summarize 379 key to be summarized
368 </dd> 380 </dd>
369 <dt><i>value</i></dt> 381 <dt><i>value</i> (int)</dt>
370 <dd> 382 <dd>
371 the value to be added to the overall statistics 383 value to be added to the overall statistics
372 </dd> 384 </dd>
373 </dl> 385 </dl>
374 <dl> 386 <dl>
375 <dt>Return:</dt> 387 <dt>Return:</dt>
376 <dd> 388 <dd>
377 the value added to the overall statistics 389 the value added to the overall statistics
378 </dd> 390 </dd>
379 </dl> 391 </dl>
392 <dl>
393 <dt>Return Type:</dt>
394 <dd>
395 int
396 </dd>
397 </dl>
380 <div align="right"><a href="#top">Up</a></div> 398 <div align="right"><a href="#top">Up</a></div>
381 <hr /> 399 <hr />
382 </body></html> 400 </body></html>

eric ide

mercurial