Mercurial Repositories > Pyramid Project / file diff

--- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog.html	Sat May 29 15:05:16 2021 +0200
+++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog.html	Tue Jun 01 19:37:46 2021 +0200
@@ -145,31 +145,29 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to be shown by the label (string)
+text to be shown by the label
 </dd>
-<dt><i>fixed=</i></dt>
+<dt><i>fixed</i> (bool)</dt>
 <dd>
-flag indicating a fixed font should be used (boolean)
+flag indicating a fixed font should be used
 </dd>
-<dt><i>linewrap=</i></dt>
+<dt><i>linewrap</i> (bool)</dt>
 <dd>
-flag indicating to wrap long lines (boolean)
+flag indicating to wrap long lines
 </dd>
-<dt><i>msgSuccess=</i></dt>
+<dt><i>msgSuccess</i> (str)</dt>
 <dd>
 optional string to show upon successful execution
-            (string)
 </dd>
-<dt><i>msgError=</i></dt>
+<dt><i>msgError</i> (str)</dt>
 <dd>
 optional string to show upon unsuccessful execution
-            (string)
 </dd>
-<dt><i>parent=</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl>
 <a NAME="PyramidDialog.__procFinished" ID="PyramidDialog.__procFinished"></a>
@@ -181,13 +179,13 @@
 </p>
 <dl>
 
-<dt><i>exitCode</i></dt>
+<dt><i>exitCode</i> (int)</dt>
 <dd>
-exit code of the process (integer)
+exit code of the process
 </dd>
-<dt><i>exitStatus</i></dt>
+<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
 <dd>
-exit status of the process (QProcess.ExitStatus)
+exit status of the process
 </dd>
 </dl>
 <a NAME="PyramidDialog.__readStderr" ID="PyramidDialog.__readStderr"></a>
@@ -229,9 +227,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QKeyEvent)</dt>
 <dd>
-the key press event (QKeyEvent)
+the key press event
 </dd>
 </dl>
 <a NAME="PyramidDialog.normalExit" ID="PyramidDialog.normalExit"></a>
@@ -244,7 +242,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating normal process termination (boolean)
+flag indicating normal process termination
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="PyramidDialog.normalExitWithoutErrors" ID="PyramidDialog.normalExitWithoutErrors"></a>
@@ -258,7 +262,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating normal process termination (boolean)
+flag indicating normal process termination
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="PyramidDialog.on_buttonBox_clicked" ID="PyramidDialog.on_buttonBox_clicked"></a>
@@ -270,9 +280,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="PyramidDialog.on_input_returnPressed" ID="PyramidDialog.on_input_returnPressed"></a>
@@ -291,9 +301,9 @@
 </p>
 <dl>
 
-<dt><i>isOn</i></dt>
+<dt><i>isOn</i> (bool)</dt>
 <dd>
-flag indicating the status of the check box (boolean)
+flag indicating the status of the check box
 </dd>
 </dl>
 <a NAME="PyramidDialog.on_sendButton_clicked" ID="PyramidDialog.on_sendButton_clicked"></a>
@@ -312,21 +322,25 @@
 </p>
 <dl>
 
-<dt><i>argsLists</i></dt>
+<dt><i>argsLists</i> (list of list of str)</dt>
 <dd>
 list of lists of arguments for the processes
-            (list of list of string)
 </dd>
-<dt><i>workingDir</i></dt>
+<dt><i>workingDir</i> (str)</dt>
 <dd>
-working directory for the process (string)
+working directory for the process
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 flag indicating a successful start of the first process
-            (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="PyramidDialog.startProcess" ID="PyramidDialog.startProcess"></a>
@@ -338,21 +352,21 @@
 </p>
 <dl>
 
-<dt><i>command</i></dt>
+<dt><i>command</i> (str)</dt>
 <dd>
-command to start (string)
+command to start
 </dd>
-<dt><i>args</i></dt>
+<dt><i>args</i> (list of str)</dt>
 <dd>
-list of arguments for the process (list of strings)
+list of arguments for the process
 </dd>
-<dt><i>workingDir=</i></dt>
+<dt><i>workingDir</i> (str)</dt>
 <dd>
-working directory for the process (string)
+working directory for the process
 </dd>
-<dt><i>showArgs=</i></dt>
+<dt><i>showArgs</i> (bool)</dt>
 <dd>
-flag indicating to show the arguments (boolean)
+flag indicating to show the arguments
 </dd>
 </dl>
 <dl>
@@ -361,6 +375,12 @@
 flag indicating a 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