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