Updated source docu.

Sat, 15 Feb 2020 12:05:00 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 15 Feb 2020 12:05:00 +0100
changeset 7414
d02ed92ef3b2
parent 7413
424f88fdee04
child 7415
e953b2a449a9
child 7423
9758025d7225

Updated source docu.

eric6/APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
eric6/APIs/Python3/eric6.bas file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.DebugClients.Python.ThreadExtension.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgImportDialog.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.QScintilla.Shell.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Utilities.ModuleParser.html file | annotate | diff | comparison | revisions
eric6/Plugins/VcsPlugins/vcsMercurial/HgImportDialog.py file | annotate | diff | comparison | revisions
--- a/eric6/APIs/Python3/eric6.api	Sat Feb 15 12:04:41 2020 +0100
+++ b/eric6/APIs/Python3/eric6.api	Sat Feb 15 12:05:00 2020 +0100
@@ -384,6 +384,7 @@
 eric6.DebugClients.Python.PyProfile.PyProfile.trace_dispatch_call?4(frame, t)
 eric6.DebugClients.Python.PyProfile.PyProfile?1(basename, timer=None, bias=None)
 eric6.DebugClients.Python.ThreadExtension.DummyThreadWrapper?1(*args, **kwargs)
+eric6.DebugClients.Python.ThreadExtension.QRunnableWrapper?1(*args, **kwargs)
 eric6.DebugClients.Python.ThreadExtension.QThreadWrapper?1(*args, **kwargs)
 eric6.DebugClients.Python.ThreadExtension.ThreadExtension._bootstrap?5(run)
 eric6.DebugClients.Python.ThreadExtension.ThreadExtension._bootstrapQThread?5(run)
@@ -4635,7 +4636,7 @@
 eric6.Plugins.VcsPlugins.vcsMercurial.HgGraftDialog.HgGraftDialog?1(vcs, revs=None, parent=None)
 eric6.Plugins.VcsPlugins.vcsMercurial.HgImportDialog.HgImportDialog.getParameters?4()
 eric6.Plugins.VcsPlugins.vcsMercurial.HgImportDialog.HgImportDialog.on_patchFilePicker_textChanged?4(txt)
-eric6.Plugins.VcsPlugins.vcsMercurial.HgImportDialog.HgImportDialog?1(parent=None)
+eric6.Plugins.VcsPlugins.vcsMercurial.HgImportDialog.HgImportDialog?1(vcs, parent=None)
 eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.COLORNAMES?7
 eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.COLORS?7
 eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.HgLogBrowserDialog.AuthorColumn?7
@@ -9109,9 +9110,11 @@
 eric6.Utilities.ModuleParser.Module.scan?4(src)
 eric6.Utilities.ModuleParser.Module?1(name, file=None, moduleType=None)
 eric6.Utilities.ModuleParser.PTL_SOURCE?7
+eric6.Utilities.ModuleParser.PY_SOURCE?7
 eric6.Utilities.ModuleParser.RB_SOURCE?7
 eric6.Utilities.ModuleParser.RbModule.addClass?4(name, _class)
 eric6.Utilities.ModuleParser.RbModule?1(module, name, file, lineno)
+eric6.Utilities.ModuleParser.SEARCH_ERROR?7
 eric6.Utilities.ModuleParser.SUPPORTED_TYPES?7
 eric6.Utilities.ModuleParser.TABWIDTH?7
 eric6.Utilities.ModuleParser.TYPE_MAPPING?7
--- a/eric6/APIs/Python3/eric6.bas	Sat Feb 15 12:04:41 2020 +0100
+++ b/eric6/APIs/Python3/eric6.bas	Sat Feb 15 12:05:00 2020 +0100
@@ -750,6 +750,7 @@
 QRegularExpressionWizardRepeatDialog QDialog Ui_QRegularExpressionWizardRepeatDialog
 QRegularExpressionWizardWidget QWidget Ui_QRegularExpressionWizardDialog
 QRegularExpressionWizardWindow E5MainWindow
+QRunnableWrapper module.QRunnable
 QThreadWrapper module.QThread
 QsciScintillaCompat QsciScintilla
 QtHelpDocumentationDialog QDialog Ui_QtHelpDocumentationDialog
Binary file eric6/Documentation/Help/source.qch has changed
--- a/eric6/Documentation/Help/source.qhp	Sat Feb 15 12:04:41 2020 +0100
+++ b/eric6/Documentation/Help/source.qhp	Sat Feb 15 12:05:00 2020 +0100
@@ -11981,6 +11981,8 @@
       <keyword name="QRegularExpressionWizardWindow" id="QRegularExpressionWizardWindow" ref="eric6.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardDialog.html#QRegularExpressionWizardWindow" />
       <keyword name="QRegularExpressionWizardWindow (Constructor)" id="QRegularExpressionWizardWindow (Constructor)" ref="eric6.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardDialog.html#QRegularExpressionWizardWindow.__init__" />
       <keyword name="QRegularExpressionWizardWindow.closeEvent" id="QRegularExpressionWizardWindow.closeEvent" ref="eric6.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardDialog.html#QRegularExpressionWizardWindow.closeEvent" />
+      <keyword name="QRunnableWrapper" id="QRunnableWrapper" ref="eric6.DebugClients.Python.ThreadExtension.html#QRunnableWrapper" />
+      <keyword name="QRunnableWrapper (Constructor)" id="QRunnableWrapper (Constructor)" ref="eric6.DebugClients.Python.ThreadExtension.html#QRunnableWrapper.__init__" />
       <keyword name="QSCINTILLA_VERSION" id="QSCINTILLA_VERSION" ref="eric6.QScintilla.QsciScintillaCompat.html#QSCINTILLA_VERSION" />
       <keyword name="QScintilla (Package)" id="QScintilla (Package)" ref="index-eric6.QScintilla.html" />
       <keyword name="QThreadWrapper" id="QThreadWrapper" ref="eric6.DebugClients.Python.ThreadExtension.html#QThreadWrapper" />
@@ -12743,6 +12745,7 @@
       <keyword name="Shell.__configure" id="Shell.__configure" ref="eric6.QScintilla.Shell.html#Shell.__configure" />
       <keyword name="Shell.__executeCommand" id="Shell.__executeCommand" ref="eric6.QScintilla.Shell.html#Shell.__executeCommand" />
       <keyword name="Shell.__find" id="Shell.__find" ref="eric6.QScintilla.Shell.html#Shell.__find" />
+      <keyword name="Shell.__flushQueuedText" id="Shell.__flushQueuedText" ref="eric6.QScintilla.Shell.html#Shell.__flushQueuedText" />
       <keyword name="Shell.__getBanner" id="Shell.__getBanner" ref="eric6.QScintilla.Shell.html#Shell.__getBanner" />
       <keyword name="Shell.__getEndPos" id="Shell.__getEndPos" ref="eric6.QScintilla.Shell.html#Shell.__getEndPos" />
       <keyword name="Shell.__indentLength" id="Shell.__indentLength" ref="eric6.QScintilla.Shell.html#Shell.__indentLength" />
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.ThreadExtension.html	Sat Feb 15 12:04:41 2020 +0100
+++ b/eric6/Documentation/Source/eric6.DebugClients.Python.ThreadExtension.html	Sat Feb 15 12:05:00 2020 +0100
@@ -39,6 +39,10 @@
 <td>Wrapper class for threading._DummyThread.</td>
 </tr>
 <tr>
+<td><a href="#QRunnableWrapper">QRunnableWrapper</a></td>
+<td>Wrapper class for *.QRunnable.</td>
+</tr>
+<tr>
 <td><a href="#QThreadWrapper">QThreadWrapper</a></td>
 <td>Wrapper class for *.QThread.</td>
 </tr>
@@ -105,6 +109,49 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="QRunnableWrapper" ID="QRunnableWrapper"></a>
+<h2>QRunnableWrapper</h2>
+
+<p>
+                Wrapper class for *.QRunnable.
+</p>
+<h3>Derived from</h3>
+module.QRunnable
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#QRunnableWrapper.__init__">QRunnableWrapper</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="QRunnableWrapper.__init__" ID="QRunnableWrapper.__init__"></a>
+<h4>QRunnableWrapper (Constructor)</h4>
+<b>QRunnableWrapper</b>(<i>*args, **kwargs</i>)
+
+<p>
+                    Constructor
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="QThreadWrapper" ID="QThreadWrapper"></a>
 <h2>QThreadWrapper</h2>
 
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgImportDialog.html	Sat Feb 15 12:04:41 2020 +0100
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgImportDialog.html	Sat Feb 15 12:05:00 2020 +0100
@@ -93,16 +93,20 @@
 
 <a NAME="HgImportDialog.__init__" ID="HgImportDialog.__init__"></a>
 <h4>HgImportDialog (Constructor)</h4>
-<b>HgImportDialog</b>(<i>parent=None</i>)
+<b>HgImportDialog</b>(<i>vcs, parent=None</i>)
 
 <p>
         Constructor
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>vcs</i> (Hg)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the VCS object
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="HgImportDialog.__updateOK" ID="HgImportDialog.__updateOK"></a>
@@ -123,9 +127,15 @@
 <dt>Returns:</dt>
 <dd>
 tuple naming the patch file, a flag indicating to not commit,
-            a commit message, a commit date, a commit user, a strip count and
-            a flag indicating to enforce the import
-            (string, boolean, string, string, string, integer, boolean)
+            a commit message, a commit date, a commit user, a flag indicating
+            to commit with the secret phase, a strip count and a flag
+            indicating to enforce the import
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, bool, str, str, str, bool, int, bool)
 </dd>
 </dl>
 <a NAME="HgImportDialog.on_patchFilePicker_textChanged" ID="HgImportDialog.on_patchFilePicker_textChanged"></a>
--- a/eric6/Documentation/Source/eric6.QScintilla.Shell.html	Sat Feb 15 12:04:41 2020 +0100
+++ b/eric6/Documentation/Source/eric6.QScintilla.Shell.html	Sat Feb 15 12:05:00 2020 +0100
@@ -272,6 +272,10 @@
 <td>Private slot to show the find widget.</td>
 </tr>
 <tr>
+<td><a href="#Shell.__flushQueuedText">__flushQueuedText</a></td>
+<td>Private slot to flush the accumulated text output.</td>
+</tr>
+<tr>
 <td><a href="#Shell.__getBanner">__getBanner</a></td>
 <td>Private method to get the banner for the remote interpreter.</td>
 </tr>
@@ -1112,6 +1116,13 @@
 <p>
         Private slot to show the find widget.
 </p>
+<a NAME="Shell.__flushQueuedText" ID="Shell.__flushQueuedText"></a>
+<h4>Shell.__flushQueuedText</h4>
+<b>__flushQueuedText</b>(<i></i>)
+
+<p>
+        Private slot to flush the accumulated text output.
+</p>
 <a NAME="Shell.__getBanner" ID="Shell.__getBanner"></a>
 <h4>Shell.__getBanner</h4>
 <b>__getBanner</b>(<i></i>)
@@ -1281,20 +1292,20 @@
 </p>
 <a NAME="Shell.__raw_input" ID="Shell.__raw_input"></a>
 <h4>Shell.__raw_input</h4>
-<b>__raw_input</b>(<i>s, echo</i>)
+<b>__raw_input</b>(<i>prompt, echo</i>)
 
 <p>
         Private method to handle raw input.
 </p>
 <dl>
 
-<dt><i>s</i></dt>
+<dt><i>prompt</i> (str)</dt>
 <dd>
-prompt to be displayed (string)
+prompt to be displayed
 </dd>
-<dt><i>echo</i></dt>
+<dt><i>echo</i> (bool)</dt>
 <dd>
-Flag indicating echoing of the input (boolean)
+Flag indicating echoing of the input
 </dd>
 </dl>
 <a NAME="Shell.__resetIncrementalHistorySearch" ID="Shell.__resetIncrementalHistorySearch"></a>
--- a/eric6/Documentation/Source/eric6.Utilities.ModuleParser.html	Sat Feb 15 12:04:41 2020 +0100
+++ b/eric6/Documentation/Source/eric6.Utilities.ModuleParser.html	Sat Feb 15 12:05:00 2020 +0100
@@ -39,7 +39,7 @@
 <h3>Global Attributes</h3>
 
 <table>
-<tr><td>PTL_SOURCE</td></tr><tr><td>RB_SOURCE</td></tr><tr><td>SUPPORTED_TYPES</td></tr><tr><td>TABWIDTH</td></tr><tr><td>TYPE_MAPPING</td></tr><tr><td>__all__</td></tr><tr><td>_commentsub</td></tr><tr><td>_hashsub</td></tr><tr><td>_modules</td></tr><tr><td>_py_getnext</td></tr><tr><td>_rb_getnext</td></tr>
+<tr><td>PTL_SOURCE</td></tr><tr><td>PY_SOURCE</td></tr><tr><td>RB_SOURCE</td></tr><tr><td>SEARCH_ERROR</td></tr><tr><td>SUPPORTED_TYPES</td></tr><tr><td>TABWIDTH</td></tr><tr><td>TYPE_MAPPING</td></tr><tr><td>__all__</td></tr><tr><td>_commentsub</td></tr><tr><td>_hashsub</td></tr><tr><td>_modules</td></tr><tr><td>_py_getnext</td></tr><tr><td>_rb_getnext</td></tr>
 </table>
 <h3>Classes</h3>
 
--- a/eric6/Plugins/VcsPlugins/vcsMercurial/HgImportDialog.py	Sat Feb 15 12:04:41 2020 +0100
+++ b/eric6/Plugins/VcsPlugins/vcsMercurial/HgImportDialog.py	Sat Feb 15 12:05:00 2020 +0100
@@ -70,7 +70,7 @@
             a commit message, a commit date, a commit user, a flag indicating
             to commit with the secret phase, a strip count and a flag
             indicating to enforce the import
-        @type tuple of (str, bool, str, str, str, bool, int, bool)
+        @rtype tuple of (str, bool, str, str, str, bool, int, bool)
         """
         if self.dateEdit.dateTime() != self.__initDateTime:
             date = self.dateEdit.dateTime().toString("yyyy-MM-dd hh:mm")

eric ide

mercurial