29 <h3>Functions</h3> |
29 <h3>Functions</h3> |
30 |
30 |
31 <table> |
31 <table> |
32 |
32 |
33 <tr> |
33 <tr> |
|
34 <td><a href="#createArgumentParser">createArgumentParser</a></td> |
|
35 <td>Function to create an argument parser.</td> |
|
36 </tr> |
|
37 <tr> |
34 <td><a href="#main">main</a></td> |
38 <td><a href="#main">main</a></td> |
35 <td>Main entry point into the application.</td> |
39 <td>Main entry point into the application.</td> |
36 </tr> |
40 </tr> |
37 <tr> |
|
38 <td><a href="#usage">usage</a></td> |
|
39 <td>Function to print some usage information.</td> |
|
40 </tr> |
|
41 <tr> |
|
42 <td><a href="#version">version</a></td> |
|
43 <td>Function to show the version information.</td> |
|
44 </tr> |
|
45 </table> |
41 </table> |
|
42 <hr /> |
|
43 <hr /> |
|
44 <a NAME="createArgumentParser" ID="createArgumentParser"></a> |
|
45 <h2>createArgumentParser</h2> |
|
46 <b>createArgumentParser</b>(<i></i>) |
|
47 |
|
48 <p> |
|
49 Function to create an argument parser. |
|
50 </p> |
|
51 <dl> |
|
52 <dt>Return:</dt> |
|
53 <dd> |
|
54 created argument parser object |
|
55 </dd> |
|
56 </dl> |
|
57 <dl> |
|
58 <dt>Return Type:</dt> |
|
59 <dd> |
|
60 argparse.ArgumentParser |
|
61 </dd> |
|
62 </dl> |
|
63 <div align="right"><a href="#top">Up</a></div> |
46 <hr /> |
64 <hr /> |
47 <hr /> |
65 <hr /> |
48 <a NAME="main" ID="main"></a> |
66 <a NAME="main" ID="main"></a> |
49 <h2>main</h2> |
67 <h2>main</h2> |
50 <b>main</b>(<i></i>) |
68 <b>main</b>(<i></i>) |
52 <p> |
70 <p> |
53 Main entry point into the application. |
71 Main entry point into the application. |
54 </p> |
72 </p> |
55 <div align="right"><a href="#top">Up</a></div> |
73 <div align="right"><a href="#top">Up</a></div> |
56 <hr /> |
74 <hr /> |
57 <hr /> |
|
58 <a NAME="usage" ID="usage"></a> |
|
59 <h2>usage</h2> |
|
60 <b>usage</b>(<i></i>) |
|
61 |
|
62 <p> |
|
63 Function to print some usage information. |
|
64 </p> |
|
65 <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 /> |
|
71 <hr /> |
|
72 <a NAME="version" ID="version"></a> |
|
73 <h2>version</h2> |
|
74 <b>version</b>(<i></i>) |
|
75 |
|
76 <p> |
|
77 Function to show the version information. |
|
78 </p> |
|
79 <div align="right"><a href="#top">Up</a></div> |
|
80 <hr /> |
|
81 </body></html> |
75 </body></html> |