uninstall.py

changeset 3019
7912530a33e2
parent 2992
dbdf27746da5
child 3039
8dd0165d805d
child 3058
0a02c433f52d
diff -r 70924c0bdaf1 -r 7912530a33e2 uninstall.py
--- a/uninstall.py	Sun Oct 13 17:44:48 2013 +0200
+++ b/uninstall.py	Mon Oct 14 18:26:25 2013 +0200
@@ -29,6 +29,8 @@
 def exit(rcode=0):
     """
     Exit the uninstall script.
+    
+    @param rcode result code to report back (integer)
     """
     # restore the local eric5config.py
     if os.path.exists("eric5config.py.orig"):
@@ -41,7 +43,7 @@
     """
     Display a usage message and exit.
 
-    rcode is the return code passed back to the calling process.
+    @param rcode return code passed back to the calling process (integer)
     """
     global progName
 
@@ -65,6 +67,10 @@
 def wrapperName(dname, wfile):
     """
     Create the platform specific name for the wrapper script.
+    
+    @param dname name of the directory to place the wrapper into
+    @param wfile basename (without extension) of the wrapper script
+    @return the name of the wrapper script
     """
     if sys.platform.startswith("win"):
         wname = dname + "\\" + wfile + ".bat"
@@ -166,7 +172,7 @@
     """
     The main function of the script.
 
-    argv is the list of command line arguments.
+    @param argv list of command line arguments
     """
     import getopt
 

eric ide

mercurial