|
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 body { |
|
8 background: #EDECE6; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #85774A; } |
|
14 h2 { color: white; background: #85774A; } |
|
15 h3 { color: white; background: #9D936E; } |
|
16 h4 { color: white; background: #9D936E; } |
|
17 |
|
18 a { color: #BA6D36; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric5.eric5_api</h1> |
|
24 <p> |
|
25 Eric5 API Generator |
|
26 </p><p> |
|
27 This is the main Python script of the API generator. It is |
|
28 this script that gets called via the API generation interface. |
|
29 This script can be used via the commandline as well. |
|
30 </p> |
|
31 <h3>Global Attributes</h3> |
|
32 <table> |
|
33 <tr><td>None</td></tr> |
|
34 </table> |
|
35 <h3>Classes</h3> |
|
36 <table> |
|
37 <tr><td>None</td></tr> |
|
38 </table> |
|
39 <h3>Functions</h3> |
|
40 <table> |
|
41 <tr> |
|
42 <td><a href="#main">main</a></td> |
|
43 <td>Main entry point into the application.</td> |
|
44 </tr><tr> |
|
45 <td><a href="#usage">usage</a></td> |
|
46 <td>Function to print some usage information.</td> |
|
47 </tr><tr> |
|
48 <td><a href="#version">version</a></td> |
|
49 <td>Function to show the version information.</td> |
|
50 </tr> |
|
51 </table> |
|
52 <hr /><hr /> |
|
53 <a NAME="main" ID="main"></a> |
|
54 <h2>main</h2> |
|
55 <b>main</b>(<i></i>) |
|
56 <p> |
|
57 Main entry point into the application. |
|
58 </p> |
|
59 <div align="right"><a href="#top">Up</a></div> |
|
60 <hr /><hr /> |
|
61 <a NAME="usage" ID="usage"></a> |
|
62 <h2>usage</h2> |
|
63 <b>usage</b>(<i></i>) |
|
64 <p> |
|
65 Function to print some usage information. |
|
66 </p><p> |
|
67 It prints a reference of all commandline parameters that may |
|
68 be used and ends the application. |
|
69 </p> |
|
70 <div align="right"><a href="#top">Up</a></div> |
|
71 <hr /><hr /> |
|
72 <a NAME="version" ID="version"></a> |
|
73 <h2>version</h2> |
|
74 <b>version</b>(<i></i>) |
|
75 <p> |
|
76 Function to show the version information. |
|
77 </p> |
|
78 <div align="right"><a href="#top">Up</a></div> |
|
79 <hr /> |
|
80 </body></html> |