Sat, 02 Jan 2010 18:52:53 +0000
More renaming to eric5.
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <?xml version="1.0" encoding="utf-8"?> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <html><head> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | <title>eric5.eric5-api</title> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | <style> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
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' |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | </style> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | </head> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | <body><a NAME="top" ID="top"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | <h1>eric5.eric5-api</h1> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | <p> |
18
3b1f5d872fd7
More renaming to eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
13 | Eric5 API Generator |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | </p><p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | This is the main Python script of the API generator. It is |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | this script that gets called via the API generation interface. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | This script can be used via the commandline as well. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | <h3>Global Attributes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <tr><td>None</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <h3>Classes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | <tr><td>None</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | <h3>Functions</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | <tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <td><a href="#main">main</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <td>Main entry point into the application.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <td><a href="#usage">usage</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | <td>Function to print some usage information.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | <td><a href="#version">version</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | <td>Function to show the version information.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | </tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | <a NAME="main" ID="main"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | <h2>main</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <b>main</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | Main entry point into the application. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
47 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | <a NAME="usage" ID="usage"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | <h2>usage</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | <b>usage</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
52 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | Function to print some usage information. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | </p><p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | It prints a reference of all commandline parameters that may |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | be used and ends the application. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | <a NAME="version" ID="version"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | <h2>version</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | <b>version</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | Function to show the version information. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | <hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | </body></html> |