Mercurial Repositories > cx_freeze Packager / file diff

--- a/CxFreeze/Documentation/source/Plugin_Packager_CxFreeze.CxFreeze.CxfreezeExecDialog.html	Thu Jun 03 14:27:52 2021 +0200
+++ b/CxFreeze/Documentation/source/Plugin_Packager_CxFreeze.CxFreeze.CxfreezeExecDialog.html	Thu Jun 03 17:51:56 2021 +0200
@@ -130,20 +130,21 @@
 </p>
 <dl>
 
-<dt><i>src</i></dt>
+<dt><i>src</i> (str)</dt>
 <dd>
-source file or folder to copy. Wildcards allowed. (str)
+source file or folder to copy. Wildcards allowed.
 </dd>
-<dt><i>dst</i></dt>
+<dt><i>dst</i> (str)</dt>
 <dd>
-destination (str)
+destination
 </dd>
 </dl>
 <dl>
 
 <dt>Raises <b>OSError</b>:</dt>
 <dd>
-raised if the given source does not exist
+raised if there is an issue writing the package or
+            the given source does not exist
 </dd>
 </dl>
 <a NAME="CopyAdditionalFiles.run" ID="CopyAdditionalFiles.run"></a>
@@ -173,15 +174,15 @@
 </p>
 <dl>
 
-<dt><i>srcname</i></dt>
+<dt><i>srcname</i> (str)</dt>
 <dd>
 actual file or folder to copy
 </dd>
-<dt><i>base</i></dt>
+<dt><i>base</i> (str)</dt>
 <dd>
 basename of the source folder
 </dd>
-<dt><i>dst</i></dt>
+<dt><i>dst</i> (str)</dt>
 <dd>
 basename of the destination folder
 </dd>
@@ -192,6 +193,12 @@
 destination path
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -297,8 +304,8 @@
         Private slot called when the process finished.
 </p>
 <p>
-        It is called when the process finished or
-        the user pressed the cancel button.
+        It is called when the process finished or the user pressed the
+        cancel button.
 </p>
 <a NAME="CxfreezeExecDialog.__finishedFreeze" ID="CxfreezeExecDialog.__finishedFreeze"></a>
 <h4>CxfreezeExecDialog.__finishedFreeze</h4>
@@ -308,8 +315,8 @@
         Private slot called when the process finished.
 </p>
 <p>
-        It is called when the process finished or
-        the user pressed the cancel button.
+        It is called when the process finished or the user pressed the
+        cancel button.
 </p>
 <a NAME="CxfreezeExecDialog.__readStderr" ID="CxfreezeExecDialog.__readStderr"></a>
 <h4>CxfreezeExecDialog.__readStderr</h4>
@@ -342,9 +349,9 @@
 </p>
 <dl>
 
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
 <dd>
-button that was clicked (QAbstractButton)
+button that was clicked
 </dd>
 </dl>
 <a NAME="CxfreezeExecDialog.start" ID="CxfreezeExecDialog.start"></a>
@@ -356,23 +363,21 @@
 </p>
 <dl>
 
-<dt><i>args</i></dt>
+<dt><i>args</i> (list of str)</dt>
 <dd>
-commandline arguments for packager program (list of
-            strings)
+commandline arguments for packager program
 </dd>
-<dt><i>parms</i></dt>
+<dt><i>parms</i> (dict)</dt>
 <dd>
-parameters got from the config dialog (dict)
+parameters got from the config dialog
 </dd>
-<dt><i>ppath</i></dt>
+<dt><i>ppath</i> (str)</dt>
 <dd>
-project path (string)
+project path
 </dd>
-<dt><i>mainscript</i></dt>
+<dt><i>mainscript</i> (str)</dt>
 <dd>
 main script name to be processed by by the packager
-            (string)
 </dd>
 </dl>
 <dl>
@@ -381,6 +386,12 @@
 flag indicating the successful start of the process
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file