|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Globals.AppInfo</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.Globals.AppInfo</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a function to generate an application info. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 <tr><td>None</td></tr> |
|
23 </table> |
|
24 <h3>Functions</h3> |
|
25 |
|
26 <table> |
|
27 |
|
28 <tr> |
|
29 <td><a href="#makeAppInfo">makeAppInfo</a></td> |
|
30 <td>Module function to generate a dictionary describing the application.</td> |
|
31 </tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="makeAppInfo" ID="makeAppInfo"></a> |
|
36 <h2>makeAppInfo</h2> |
|
37 <b>makeAppInfo</b>(<i>argv, name, arg, description, options=None</i>) |
|
38 |
|
39 <p> |
|
40 Module function to generate a dictionary describing the application. |
|
41 </p> |
|
42 <dl> |
|
43 |
|
44 <dt><i>argv</i></dt> |
|
45 <dd> |
|
46 list of commandline parameters (list of strings) |
|
47 </dd> |
|
48 <dt><i>name</i></dt> |
|
49 <dd> |
|
50 name of the application (string) |
|
51 </dd> |
|
52 <dt><i>arg</i></dt> |
|
53 <dd> |
|
54 commandline arguments (string) |
|
55 </dd> |
|
56 <dt><i>description</i></dt> |
|
57 <dd> |
|
58 text describing the application (string) |
|
59 </dd> |
|
60 <dt><i>options</i></dt> |
|
61 <dd> |
|
62 list of additional commandline options |
|
63 (list of tuples of two strings (commandline option, |
|
64 option description)). The options --version, --help and -h are |
|
65 always present and must not be repeated in this list. |
|
66 </dd> |
|
67 </dl> |
|
68 <dl> |
|
69 <dt>Return:</dt> |
|
70 <dd> |
|
71 dictionary describing the application |
|
72 </dd> |
|
73 </dl> |
|
74 <div align="right"><a href="#top">Up</a></div> |
|
75 <hr /> |
|
76 </body></html> |