Mercurial Repositories > Eric Assistant / file comparison
comparison: AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html
AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html
- changeset 143
- 468560828f55
- parent 140
- a0ea7418d433
- child 163
- 842fce9b31ce
equal
deleted
inserted
replaced
| 142:eac390ad0c2e | 143:468560828f55 |
|---|---|
| 566 </dl> | 566 </dl> |
| 567 <h3>Derived from</h3> | 567 <h3>Derived from</h3> |
| 568 QThread | 568 QThread |
| 569 <h3>Class Attributes</h3> | 569 <h3>Class Attributes</h3> |
| 570 <table> | 570 <table> |
| 571 <tr><td>file_delete_id_stmt</td></tr><tr><td>file_id_stmt</td></tr><tr><td>file_loaded_stmt</td></tr><tr><td>populate_api_stmt</td></tr><tr><td>populate_bases_stmt</td></tr><tr><td>populate_del_api_stmt</td></tr><tr><td>populate_del_bases_stmt</td></tr><tr><td>populate_file_stmt</td></tr><tr><td>update_file_stmt</td></tr> | 571 <tr><td>api_files_stmt</td></tr><tr><td>file_delete_id_stmt</td></tr><tr><td>file_id_stmt</td></tr><tr><td>file_loaded_stmt</td></tr><tr><td>populate_api_stmt</td></tr><tr><td>populate_bases_stmt</td></tr><tr><td>populate_del_api_stmt</td></tr><tr><td>populate_del_bases_stmt</td></tr><tr><td>populate_file_stmt</td></tr><tr><td>update_file_stmt</td></tr> |
| 572 </table> | 572 </table> |
| 573 <h3>Class Methods</h3> | 573 <h3>Class Methods</h3> |
| 574 <table> | 574 <table> |
| 575 <tr><td>None</td></tr> | 575 <tr><td>None</td></tr> |
| 576 </table> | 576 </table> |
| 587 <td>Private method to generate class api section for class attributes.</td> | 587 <td>Private method to generate class api section for class attributes.</td> |
| 588 </tr><tr> | 588 </tr><tr> |
| 589 <td><a href="#DbAPIsWorker.__deleteApiFile">__deleteApiFile</a></td> | 589 <td><a href="#DbAPIsWorker.__deleteApiFile">__deleteApiFile</a></td> |
| 590 <td>Private method to delete all references to an api file.</td> | 590 <td>Private method to delete all references to an api file.</td> |
| 591 </tr><tr> | 591 </tr><tr> |
| 592 <td><a href="#DbAPIsWorker.__getApiFiles">__getApiFiles</a></td> | |
| 593 <td>Private method to get a list of API files loaded into the database.</td> | |
| 594 </tr><tr> | |
| 592 <td><a href="#DbAPIsWorker.__loadApiFile">__loadApiFile</a></td> | 595 <td><a href="#DbAPIsWorker.__loadApiFile">__loadApiFile</a></td> |
| 593 <td>Private method to read a raw API file into the database.</td> | 596 <td>Private method to read a raw API file into the database.</td> |
| 594 </tr><tr> | 597 </tr><tr> |
| 595 <td><a href="#DbAPIsWorker.__loadApiFileIfNewer">__loadApiFileIfNewer</a></td> | 598 <td><a href="#DbAPIsWorker.__loadApiFileIfNewer">__loadApiFileIfNewer</a></td> |
| 596 <td>Private method to load an API file, if it is newer than the one read into the database.</td> | 599 <td>Private method to load an API file, if it is newer than the one read into the database.</td> |
| 612 <table> | 615 <table> |
| 613 <tr><td>None</td></tr> | 616 <tr><td>None</td></tr> |
| 614 </table> | 617 </table> |
| 615 <a NAME="DbAPIsWorker.__init__" ID="DbAPIsWorker.__init__"></a> | 618 <a NAME="DbAPIsWorker.__init__" ID="DbAPIsWorker.__init__"></a> |
| 616 <h4>DbAPIsWorker (Constructor)</h4> | 619 <h4>DbAPIsWorker (Constructor)</h4> |
| 617 <b>DbAPIsWorker</b>(<i>proxy, language, apiFiles, projectPath="", refresh=False, projectType=""</i>) | 620 <b>DbAPIsWorker</b>(<i>proxy, language, apiFiles, dbName, projectPath="", refresh=False, projectType=""</i>) |
| 618 <p> | 621 <p> |
| 619 Constructor | 622 Constructor |
| 620 </p><dl> | 623 </p><dl> |
| 621 <dt><i>proxy</i> (DbAPIs)</dt> | 624 <dt><i>proxy</i> (DbAPIs)</dt> |
| 622 <dd> | 625 <dd> |
| 625 <dd> | 628 <dd> |
| 626 language of the APIs object | 629 language of the APIs object |
| 627 </dd><dt><i>apiFiles</i> (list of str)</dt> | 630 </dd><dt><i>apiFiles</i> (list of str)</dt> |
| 628 <dd> | 631 <dd> |
| 629 list of API files to process | 632 list of API files to process |
| 633 </dd><dt><i>dbName</i> (str)</dt> | |
| 634 <dd> | |
| 635 path name of the database file | |
| 630 </dd><dt><i>projectPath</i> (str)</dt> | 636 </dd><dt><i>projectPath</i> (str)</dt> |
| 631 <dd> | 637 <dd> |
| 632 path of the project. Only needed, if the APIs | 638 path of the project. Only needed, if the APIs |
| 633 are extracted out of the sources of a project. | 639 are extracted out of the sources of a project. |
| 634 </dd><dt><i>refresh</i> (bool)</dt> | 640 </dd><dt><i>refresh</i> (bool)</dt> |
| 675 Private method to delete all references to an api file. | 681 Private method to delete all references to an api file. |
| 676 </p><dl> | 682 </p><dl> |
| 677 <dt><i>apiFile</i></dt> | 683 <dt><i>apiFile</i></dt> |
| 678 <dd> | 684 <dd> |
| 679 filename of the raw API file (string) | 685 filename of the raw API file (string) |
| 686 </dd> | |
| 687 </dl><a NAME="DbAPIsWorker.__getApiFiles" ID="DbAPIsWorker.__getApiFiles"></a> | |
| 688 <h4>DbAPIsWorker.__getApiFiles</h4> | |
| 689 <b>__getApiFiles</b>(<i></i>) | |
| 690 <p> | |
| 691 Private method to get a list of API files loaded into the database. | |
| 692 </p><dl> | |
| 693 <dt>Returns:</dt> | |
| 694 <dd> | |
| 695 list of API filenames | |
| 696 </dd> | |
| 697 </dl><dl> | |
| 698 <dt>Return Type:</dt> | |
| 699 <dd> | |
| 700 list of str | |
| 680 </dd> | 701 </dd> |
| 681 </dl><a NAME="DbAPIsWorker.__loadApiFile" ID="DbAPIsWorker.__loadApiFile"></a> | 702 </dl><a NAME="DbAPIsWorker.__loadApiFile" ID="DbAPIsWorker.__loadApiFile"></a> |
| 682 <h4>DbAPIsWorker.__loadApiFile</h4> | 703 <h4>DbAPIsWorker.__loadApiFile</h4> |
| 683 <b>__loadApiFile</b>(<i>apiFile</i>) | 704 <b>__loadApiFile</b>(<i>apiFile</i>) |
| 684 <p> | 705 <p> |
