Documentation/Source/eric5.eric5_doc.html

Sat, 26 Jan 2013 12:44:46 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 26 Jan 2013 12:44:46 +0100
branch
5_3_x
changeset 2374
f78ee0e8f96c
parent 911
f5308fe3a1b2
child 2386
bf6f0ded6071
permissions
-rw-r--r--

Regenerated the source docu with the HTML5 generator.

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

eric ide

mercurial