--- a/scripts/install-debugclients.py Mon Dec 18 16:39:44 2023 +0100 +++ b/scripts/install-debugclients.py Mon Dec 18 17:45:20 2023 +0100 @@ -41,7 +41,8 @@ """ Exit the install script. - @param rcode result code to report back (integer) + @param rcode result code to report back + @type int """ global currDir @@ -79,11 +80,16 @@ Copy files of a directory tree. @param src name of the source directory + @type str @param dst name of the destination directory + @type str @param filters list of filter pattern determining the files to be copied + @type list of str @param excludeDirs list of (sub)directories to exclude from copying + @type list of str @param excludePatterns list of filter pattern determining the files to be skipped + @type str """ if excludeDirs is None: excludeDirs = [] @@ -121,7 +127,8 @@ Cleanup the sources directory to get rid of leftover files and directories. - @param dirName name of the directory to prune (string) + @param dirName name of the directory to prune + @type str """ # step 1: delete the __pycache__ directory and all *.pyc files if os.path.exists(os.path.join(dirName, "__pycache__")): @@ -158,9 +165,12 @@ """ Wrapper function around shutil.copy() to ensure the permissions. - @param src source file name (string) - @param dst destination file name or directory name (string) - @param perm permissions to be set (integer) + @param src source file name + @type str + @param dst destination file name or directory name + @type str + @param perm permissions to be set + @type int """ shutil.copy(src, dst) if os.path.isdir(dst): @@ -172,7 +182,8 @@ """ Actually perform the installation steps. - @return result code (integer) + @return result code + @rtype int """ global distDir, doCleanup, sourceDir, modDir @@ -403,7 +414,8 @@ """ The main function of the script. - @param argv the list of command line arguments. + @param argv the list of command line arguments + @type list of str """ global modDir, doCleanup, doCompile, distDir global sourceDir, eric7SourceDir