|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.eric5-api</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.eric5-api</h1> |
|
12 <p> |
|
13 Eric4 API Generator |
|
14 </p><p> |
|
15 This is the main Python script of the API generator. It is |
|
16 this script that gets called via the API generation interface. |
|
17 This script can be used via the commandline as well. |
|
18 </p> |
|
19 <h3>Global Attributes</h3> |
|
20 <table> |
|
21 <tr><td>None</td></tr> |
|
22 </table> |
|
23 <h3>Classes</h3> |
|
24 <table> |
|
25 <tr><td>None</td></tr> |
|
26 </table> |
|
27 <h3>Functions</h3> |
|
28 <table> |
|
29 <tr> |
|
30 <td><a href="#main">main</a></td> |
|
31 <td>Main entry point into the application.</td> |
|
32 </tr><tr> |
|
33 <td><a href="#usage">usage</a></td> |
|
34 <td>Function to print some usage information.</td> |
|
35 </tr><tr> |
|
36 <td><a href="#version">version</a></td> |
|
37 <td>Function to show the version information.</td> |
|
38 </tr> |
|
39 </table> |
|
40 <hr /><hr /> |
|
41 <a NAME="main" ID="main"></a> |
|
42 <h2>main</h2> |
|
43 <b>main</b>(<i></i>) |
|
44 <p> |
|
45 Main entry point into the application. |
|
46 </p> |
|
47 <div align="right"><a href="#top">Up</a></div> |
|
48 <hr /><hr /> |
|
49 <a NAME="usage" ID="usage"></a> |
|
50 <h2>usage</h2> |
|
51 <b>usage</b>(<i></i>) |
|
52 <p> |
|
53 Function to print some usage information. |
|
54 </p><p> |
|
55 It prints a reference of all commandline parameters that may |
|
56 be used and ends the application. |
|
57 </p> |
|
58 <div align="right"><a href="#top">Up</a></div> |
|
59 <hr /><hr /> |
|
60 <a NAME="version" ID="version"></a> |
|
61 <h2>version</h2> |
|
62 <b>version</b>(<i></i>) |
|
63 <p> |
|
64 Function to show the version information. |
|
65 </p> |
|
66 <div align="right"><a href="#top">Up</a></div> |
|
67 <hr /> |
|
68 </body></html> |