Documentation/Source/eric5.uninstall.html

changeset 3019
7912530a33e2
parent 2966
f85f686981ad
child 3597
137370f7114b
--- a/Documentation/Source/eric5.uninstall.html	Sun Oct 13 17:44:48 2013 +0200
+++ b/Documentation/Source/eric5.uninstall.html	Mon Oct 14 18:26:25 2013 +0200
@@ -59,7 +59,12 @@
 <b>exit</b>(<i>rcode=0</i>)
 <p>
     Exit the uninstall script.
-</p>
+</p><dl>
+<dt><i>rcode</i></dt>
+<dd>
+result code to report back (integer)
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
 <a NAME="initGlobals" ID="initGlobals"></a>
@@ -75,9 +80,12 @@
 <b>main</b>(<i>argv</i>)
 <p>
     The main function of the script.
-</p><p>
-    argv is the list of command line arguments.
-</p>
+</p><dl>
+<dt><i>argv</i></dt>
+<dd>
+list of command line arguments
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
 <a NAME="uninstallEric" ID="uninstallEric"></a>
@@ -93,9 +101,12 @@
 <b>usage</b>(<i>rcode=2</i>)
 <p>
     Display a usage message and exit.
-</p><p>
-    rcode is the return code passed back to the calling process.
-</p>
+</p><dl>
+<dt><i>rcode</i></dt>
+<dd>
+return code passed back to the calling process (integer)
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
 <a NAME="wrapperName" ID="wrapperName"></a>
@@ -103,7 +114,20 @@
 <b>wrapperName</b>(<i>dname, wfile</i>)
 <p>
     Create the platform specific name for the wrapper script.
-</p>
+</p><dl>
+<dt><i>dname</i></dt>
+<dd>
+name of the directory to place the wrapper into
+</dd><dt><i>wfile</i></dt>
+<dd>
+basename (without extension) of the wrapper script
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the name of the wrapper script
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial