Documentation/Source/eric5.Utilities.Startup.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 103
59137afca666
--- a/Documentation/Source/eric5.Utilities.Startup.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Utilities.Startup.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Utilities.Startup</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#115;&#111;&#109;&#101; &#115;&#116;&#97;&#114;&#116;&#117;&#112; &#104;&#101;&#108;&#112;&#101;&#114; &#102;&#117;&#110;&#99;&#105;&#111;&#110;&#115;
+Module implementing some startup helper funcions
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -36,28 +36,28 @@
 <table>
 <tr>
 <td><a href="#handleArgs">handleArgs</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#97;&#108;w&#97;y&#115; &#112;&#114;&#101;&#115;&#101;&#110;&#116; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#111;&#112;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Module function to handle the always present commandline options.</td>
 </tr><tr>
 <td><a href="#initializeResourceSearchPath">initializeResourceSearchPath</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; &#109;&#105;&#109;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#97;&#99;&#116;&#111;&#114;y.</td>
+<td>Module function to initialize the default mime source factory.</td>
 </tr><tr>
 <td><a href="#loadTranslatorForLocale">loadTranslatorForLocale</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#102;&#105;&#110;&#100; &#97;&#110;&#100; &#108;&#111;&#97;&#100; &#97; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Module function to find and load a specific translation.</td>
 </tr><tr>
 <td><a href="#loadTranslators">loadTranslators</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#108;&#111;&#97;&#100; &#97;&#108;&#108; &#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100; &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Module function to load all required translations.</td>
 </tr><tr>
 <td><a href="#makeAppInfo">makeAppInfo</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#100;&#101;&#115;&#99;&#114;&#105;&#98;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Module function to generate a dictionary describing the application.</td>
 </tr><tr>
 <td><a href="#simpleAppStartup">simpleAppStartup</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#117;&#112; &#97;&#110; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110; &#116;&#104;&#97;&#116; &#100;&#111;&#101;&#115;&#110;'&#116; &#110;&#101;&#101;&#100; &#97; &#115;&#112;&#101;&#99;&#105;&#97;&#108;&#105;z&#101;&#100; &#115;&#116;&#97;&#114;&#116; &#117;&#112;.</td>
+<td>Module function to start up an application that doesn't need a specialized start up.</td>
 </tr><tr>
 <td><a href="#usage">usage</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#117;&#115;&#97;&#103;&#101; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Module function to show the usage information.</td>
 </tr><tr>
 <td><a href="#version">version</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Module function to show the version information.</td>
 </tr>
 </table>
 <hr /><hr />
@@ -65,21 +65,21 @@
 <h2>handleArgs</h2>
 <b>handleArgs</b>(<i>argv, appinfo</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#97;&#108;w&#97;y&#115; &#112;&#114;&#101;&#115;&#101;&#110;&#116; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#111;&#112;&#116;&#105;&#111;&#110;&#115;.
+    Module function to handle the always present commandline options.
 </p><dl>
 <dt><i>argv</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of commandline parameters (list of strings)
 </dd><dt><i>appinfo</i></dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#100;&#101;&#115;&#99;&#114;&#105;&#98;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;
+dictionary describing the application
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#105;&#110;&#100;&#101;x &#111;&#102; &#116;&#104;&#101; '--' &#111;&#112;&#116;&#105;&#111;&#110; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;). &#84;&#104;&#105;&#115; &#105;&#115; &#117;&#115;&#101;&#100; &#116;&#111; &#116;&#101;&#108;&#108;
-        &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;, &#116;&#104;&#97;&#116; &#97;&#108;&#108; &#97;&#100;&#100;&#105;&#116;&#105;&#111;&#110;&#97;&#108; &#111;&#112;&#116;&#105;&#111;&#110; &#100;&#111;&#110;'&#116; &#98;&#101;&#108;&#111;&#110;&#103; &#116;&#111;
-        &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;.
+index of the '--' option (integer). This is used to tell
+        the application, that all additional option don't belong to
+        the application.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -88,7 +88,7 @@
 <h2>initializeResourceSearchPath</h2>
 <b>initializeResourceSearchPath</b>(<i></i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; &#109;&#105;&#109;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#97;&#99;&#116;&#111;&#114;y.
+    Module function to initialize the default mime source factory.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -96,19 +96,19 @@
 <h2>loadTranslatorForLocale</h2>
 <b>loadTranslatorForLocale</b>(<i>dirs, tn</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#102;&#105;&#110;&#100; &#97;&#110;&#100; &#108;&#111;&#97;&#100; &#97; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#105;&#111;&#110;.
+    Module function to find and load a specific translation.
 </p><dl>
 <dt><i>dirs</i></dt>
 <dd>
-&#83;&#101;&#97;&#114;&#99;&#104;&#112;&#97;&#116;&#104; &#102;&#111;&#114; &#116;&#104;&#101; &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#105;&#111;&#110;&#115;. (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+Searchpath for the translations. (list of strings)
 </dd><dt><i>tn</i></dt>
 <dd>
-&#84;&#104;&#101; &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#105;&#111;&#110; &#116;&#111; &#98;&#101; &#108;&#111;&#97;&#100;&#101;&#100;. (&#115;&#116;&#114;&#105;&#110;&#103;)
+The translation to be loaded. (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#84;&#117;&#112;&#108;&#101; &#111;&#102; &#97; &#115;&#116;&#97;&#116;&#117;&#115; &#102;&#108;&#97;&#103; &#97;&#110;&#100; &#116;&#104;&#101; &#108;&#111;&#97;&#100;&#101;&#100; &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#111;&#114;. (&#105;&#110;&#116;, &#81;&#84;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#111;&#114;)
+Tuple of a status flag and the loaded translator. (int, QTranslator)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -117,23 +117,23 @@
 <h2>loadTranslators</h2>
 <b>loadTranslators</b>(<i>qtTransDir, app, translationFiles = ()</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#108;&#111;&#97;&#100; &#97;&#108;&#108; &#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100; &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#105;&#111;&#110;&#115;.
+    Module function to load all required translations.
 </p><dl>
 <dt><i>qtTransDir</i></dt>
 <dd>
-&#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#111;&#102; &#116;&#104;&#101; &#81;&#116; &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#105;&#111;&#110;&#115; &#102;&#105;&#108;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+directory of the Qt translations files (string)
 </dd><dt><i>app</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#65;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;)
+reference to the application object (QApplication)
 </dd><dt><i>translationFiles</i></dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#97;&#100;&#100;&#105;&#116;&#105;&#111;&#110;&#97;&#108; &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#105;&#111;&#110;&#115; &#116;&#111;
-        &#98;&#101; &#108;&#111;&#97;&#100;&#101;&#100; (&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+tuple of additional translations to
+        be loaded (tuple of strings)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; &#114;&#101;&#113;&#117;&#101;&#115;&#116;&#101;&#100; &#108;&#111;&#99;&#97;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the requested locale (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -142,31 +142,31 @@
 <h2>makeAppInfo</h2>
 <b>makeAppInfo</b>(<i>argv, name, arg, description, options = []</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#100;&#101;&#115;&#99;&#114;&#105;&#98;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;.
+    Module function to generate a dictionary describing the application.
 </p><dl>
 <dt><i>argv</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of commandline parameters (list of strings)
 </dd><dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the application (string)
 </dd><dt><i>arg</i></dt>
 <dd>
-&#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#97;&#114;&#103;&#117;&#109;&#101;&#110;&#116;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+commandline arguments (string)
 </dd><dt><i>description</i></dt>
 <dd>
-&#116;&#101;x&#116; &#100;&#101;&#115;&#99;&#114;&#105;&#98;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+text describing the application (string)
 </dd><dt><i>options</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#97;&#100;&#100;&#105;&#116;&#105;&#111;&#110;&#97;&#108; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#111;&#112;&#116;&#105;&#111;&#110;&#115;
-        (&#108;&#105;&#115;&#116; &#111;&#102; &#116;&#117;&#112;&#108;&#101;&#115; &#111;&#102; &#116;w&#111; &#115;&#116;&#114;&#105;&#110;&#103;&#115; (&#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#111;&#112;&#116;&#105;&#111;&#110;, &#111;&#112;&#116;&#105;&#111;&#110; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;)).
-        &#84;&#104;&#101; &#111;&#112;&#116;&#105;&#111;&#110;&#115; --v&#101;&#114;&#115;&#105;&#111;&#110;, --&#104;&#101;&#108;&#112; &#97;&#110;&#100; -&#104; &#97;&#114;&#101; &#97;&#108;w&#97;y&#115; &#112;&#114;&#101;&#115;&#101;&#110;&#116; &#97;&#110;&#100; &#109;&#117;&#115;&#116; &#110;&#111;&#116;
-        &#98;&#101; &#114;&#101;&#112;&#101;&#97;&#116;&#101;&#100; &#105;&#110; &#116;&#104;&#105;&#115; &#108;&#105;&#115;&#116;.
+list of additional commandline options
+        (list of tuples of two strings (commandline option, option description)).
+        The options --version, --help and -h are always present and must not
+        be repeated in this list.
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#100;&#101;&#115;&#99;&#114;&#105;&#98;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;
+dictionary describing the application
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -175,28 +175,28 @@
 <h2>simpleAppStartup</h2>
 <b>simpleAppStartup</b>(<i>argv, appinfo, mwFactory, quitOnLastWindowClosed = True</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#117;&#112; &#97;&#110; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110; &#116;&#104;&#97;&#116; &#100;&#111;&#101;&#115;&#110;'&#116; &#110;&#101;&#101;&#100; &#97; &#115;&#112;&#101;&#99;&#105;&#97;&#108;&#105;z&#101;&#100; &#115;&#116;&#97;&#114;&#116; &#117;&#112;.
+    Module function to start up an application that doesn't need a specialized start up.
 </p><p>
-    &#84;&#104;&#105;&#115; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#105;&#115; &#117;&#115;&#101;&#100; &#98;y &#97;&#108;&#108; &#111;&#102; &#101;&#114;&#105;&#99;&#53;'&#115; &#104;&#101;&#108;&#112;&#101;&#114; &#112;&#114;&#111;&#103;&#114;&#97;&#109;&#115;.
+    This function is used by all of eric5's helper programs.
 </p><dl>
 <dt><i>argv</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of commandline parameters (list of strings)
 </dd><dt><i>appinfo</i></dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#100;&#101;&#115;&#99;&#114;&#105;&#98;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;
+dictionary describing the application
 </dd><dt><i>mwFactory</i></dt>
 <dd>
-&#102;&#97;&#99;&#116;&#111;&#114;y &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#109;&#97;&#105;&#110; w&#105;&#100;&#103;&#101;&#116;. &#84;&#104;&#105;&#115;
-        &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#109;&#117;&#115;&#116; &#97;&#99;&#99;&#101;&#112;&#116; &#116;&#104;&#101; &#102;&#111;&#108;&#108;&#111;w&#105;&#110;&#103; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;.
-        &#60;&#100;&#108;&#62;
-            &#60;&#100;&#116;&#62;&#97;&#114;&#103;v&#60;/&#100;&#116;&#62;
-            &#60;&#100;&#100;&#62;&#108;&#105;&#115;&#116; &#111;&#102; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)&#60;/&#100;&#100;&#62;
-        &#60;/&#100;&#108;&#62;
+factory function generating the main widget. This
+        function must accept the following parameter.
+        <dl>
+            <dt>argv</dt>
+            <dd>list of commandline parameters (list of strings)</dd>
+        </dl>
 </dd><dt><i>quitOnLastWindowClosed=</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#111; &#113;&#117;&#105;&#116; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;,
-        &#105;&#102; &#116;&#104;&#101; &#108;&#97;&#115;&#116; w&#105;&#110;&#100;&#111;w w&#97;&#115; &#99;&#108;&#111;&#115;&#101;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating to quit the application,
+        if the last window was closed (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -205,14 +205,14 @@
 <h2>usage</h2>
 <b>usage</b>(<i>appinfo, optlen = 12</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#117;&#115;&#97;&#103;&#101; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.
+    Module function to show the usage information.
 </p><dl>
 <dt><i>appinfo</i></dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#100;&#101;&#115;&#99;&#114;&#105;&#98;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;
+dictionary describing the application
 </dd><dt><i>optlen</i></dt>
 <dd>
-&#108;&#101;&#110;&#103;&#116;&#104; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#101;&#108;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#111;&#112;&#116;&#105;&#111;&#110; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+length of the field for the commandline option (integer)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -221,11 +221,11 @@
 <h2>version</h2>
 <b>version</b>(<i>appinfo</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.
+    Module function to show the version information.
 </p><dl>
 <dt><i>appinfo</i></dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#100;&#101;&#115;&#99;&#114;&#105;&#98;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;
+dictionary describing the application
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial