51 <h3>Functions</h3> |
51 <h3>Functions</h3> |
52 |
52 |
53 <table> |
53 <table> |
54 |
54 |
55 <tr> |
55 <tr> |
|
56 <td><a href="#clearModulesCache">clearModulesCache</a></td> |
|
57 <td>Function to clear the cached modules.</td> |
|
58 </tr> |
|
59 <tr> |
56 <td><a href="#readmodule_ex">readmodule_ex</a></td> |
60 <td><a href="#readmodule_ex">readmodule_ex</a></td> |
57 <td>Read a Ruby file and return a dictionary of classes, functions and modules.</td> |
61 <td>Read a Ruby file and return a dictionary of classes, functions and modules.</td> |
58 </tr> |
62 </tr> |
59 <tr> |
63 <tr> |
60 <td><a href="#scan">scan</a></td> |
64 <td><a href="#scan">scan</a></td> |
364 Constructor |
368 Constructor |
365 </p> |
369 </p> |
366 <div align="right"><a href="#top">Up</a></div> |
370 <div align="right"><a href="#top">Up</a></div> |
367 <hr /> |
371 <hr /> |
368 <hr /> |
372 <hr /> |
|
373 <a NAME="clearModulesCache" ID="clearModulesCache"></a> |
|
374 <h2>clearModulesCache</h2> |
|
375 <b>clearModulesCache</b>(<i></i>) |
|
376 |
|
377 <p> |
|
378 Function to clear the cached modules. |
|
379 </p> |
|
380 <div align="right"><a href="#top">Up</a></div> |
|
381 <hr /> |
|
382 <hr /> |
369 <a NAME="readmodule_ex" ID="readmodule_ex"></a> |
383 <a NAME="readmodule_ex" ID="readmodule_ex"></a> |
370 <h2>readmodule_ex</h2> |
384 <h2>readmodule_ex</h2> |
371 <b>readmodule_ex</b>(<i>module, path=None</i>) |
385 <b>readmodule_ex</b>(<i>module, path=None, isTypeFile=False</i>) |
372 |
386 |
373 <p> |
387 <p> |
374 Read a Ruby file and return a dictionary of classes, functions and modules. |
388 Read a Ruby file and return a dictionary of classes, functions and modules. |
375 </p> |
389 </p> |
376 <dl> |
390 <dl> |
377 |
391 |
378 <dt><i>module</i></dt> |
392 <dt><i>module</i> (str)</dt> |
379 <dd> |
393 <dd> |
380 name of the Ruby file (string) |
394 name of the Ruby file |
381 </dd> |
395 </dd> |
382 <dt><i>path</i></dt> |
396 <dt><i>path</i> (list of str)</dt> |
383 <dd> |
397 <dd> |
384 path the file should be searched in (list of strings) |
398 path the file should be searched in |
|
399 </dd> |
|
400 <dt><i>isTypeFile</i> (bool)</dt> |
|
401 <dd> |
|
402 flag indicating a file of this type |
385 </dd> |
403 </dd> |
386 </dl> |
404 </dl> |
387 <dl> |
405 <dl> |
388 <dt>Return:</dt> |
406 <dt>Return:</dt> |
389 <dd> |
407 <dd> |
390 the resulting dictionary |
408 the resulting dictionary |
|
409 </dd> |
|
410 </dl> |
|
411 <dl> |
|
412 <dt>Return Type:</dt> |
|
413 <dd> |
|
414 dict |
391 </dd> |
415 </dd> |
392 </dl> |
416 </dl> |
393 <div align="right"><a href="#top">Up</a></div> |
417 <div align="right"><a href="#top">Up</a></div> |
394 <hr /> |
418 <hr /> |
395 <hr /> |
419 <hr /> |