Updated source documentation. eric7

Sun, 17 Jul 2022 18:48:09 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 17 Jul 2022 18:48:09 +0200
branch
eric7
changeset 9244
3bf1a02df07a
parent 9243
73c7abe824f3
child 9245
6ee1705a1cb9

Updated source documentation.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/APIs/Python3/eric7.bas file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.PipInterface.PipFreezeDialog.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Sun Jul 17 18:47:23 2022 +0200
+++ b/src/eric7/APIs/Python3/eric7.api	Sun Jul 17 18:48:09 2022 +0200
@@ -3124,7 +3124,9 @@
 eric7.PipInterface.PipFreezeDialog.PipFreezeDialog.on_saveToButton_clicked?4()
 eric7.PipInterface.PipFreezeDialog.PipFreezeDialog.on_userCheckBox_clicked?4()
 eric7.PipInterface.PipFreezeDialog.PipFreezeDialog.start?4(venvName)
-eric7.PipInterface.PipFreezeDialog.PipFreezeDialog?1(pip, parent=None)
+eric7.PipInterface.PipFreezeDialog.PipFreezeDialog?1(pip, mode=PipFreezeDialogModes.Requirements, parent=None)
+eric7.PipInterface.PipFreezeDialog.PipFreezeDialogModes.Constraints?7
+eric7.PipInterface.PipFreezeDialog.PipFreezeDialogModes.Requirements?7
 eric7.PipInterface.PipLicensesDialog.PipLicensesDialog.LicensesLicenseColumn?7
 eric7.PipInterface.PipLicensesDialog.PipLicensesDialog.LicensesPackageColumn?7
 eric7.PipInterface.PipLicensesDialog.PipLicensesDialog.LicensesVersionColumn?7
@@ -5855,9 +5857,9 @@
 eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgGetCurrentBranch?4()
 eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgGetTagsList?4(withType=False)
 eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgGraft?4(revs=None)
-eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgGraftAbort?4(path)
-eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgGraftContinue?4(path)
-eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgGraftStop?4(path)
+eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgGraftAbort?4()
+eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgGraftContinue?4()
+eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgGraftStop?4()
 eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgIdentify?4()
 eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgImport?4()
 eric7.Plugins.VcsPlugins.vcsMercurial.hg.Hg.hgIncoming?4()
--- a/src/eric7/APIs/Python3/eric7.bas	Sun Jul 17 18:47:23 2022 +0200
+++ b/src/eric7/APIs/Python3/eric7.bas	Sun Jul 17 18:48:09 2022 +0200
@@ -719,6 +719,7 @@
 PipDialog QDialog Ui_PipDialog
 PipFileSelectionDialog QDialog Ui_PipFileSelectionDialog
 PipFreezeDialog QDialog Ui_PipFreezeDialog
+PipFreezeDialogModes enum.Enum
 PipLicensesDialog QDialog Ui_PipLicensesDialog
 PipPackageDetailsDialog QDialog Ui_PipPackageDetailsDialog
 PipPackagesInputDialog QDialog Ui_PipPackagesInputDialog
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Sun Jul 17 18:47:23 2022 +0200
+++ b/src/eric7/Documentation/Help/source.qhp	Sun Jul 17 18:48:09 2022 +0200
@@ -11443,6 +11443,7 @@
       <keyword name="PipFreezeDialog.on_saveToButton_clicked" id="PipFreezeDialog.on_saveToButton_clicked" ref="eric7.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_saveToButton_clicked" />
       <keyword name="PipFreezeDialog.on_userCheckBox_clicked" id="PipFreezeDialog.on_userCheckBox_clicked" ref="eric7.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_userCheckBox_clicked" />
       <keyword name="PipFreezeDialog.start" id="PipFreezeDialog.start" ref="eric7.PipInterface.PipFreezeDialog.html#PipFreezeDialog.start" />
+      <keyword name="PipFreezeDialogModes" id="PipFreezeDialogModes" ref="eric7.PipInterface.PipFreezeDialog.html#PipFreezeDialogModes" />
       <keyword name="PipInterface (Package)" id="PipInterface (Package)" ref="index-eric7.PipInterface.html" />
       <keyword name="PipLicensesDialog" id="PipLicensesDialog" ref="eric7.PipInterface.PipLicensesDialog.html#PipLicensesDialog" />
       <keyword name="PipLicensesDialog (Constructor)" id="PipLicensesDialog (Constructor)" ref="eric7.PipInterface.PipLicensesDialog.html#PipLicensesDialog.__init__" />
@@ -11478,6 +11479,7 @@
       <keyword name="PipPackagesWidget.__editUserConfiguration" id="PipPackagesWidget.__editUserConfiguration" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__editUserConfiguration" />
       <keyword name="PipPackagesWidget.__editVirtualenvConfiguration" id="PipPackagesWidget.__editVirtualenvConfiguration" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__editVirtualenvConfiguration" />
       <keyword name="PipPackagesWidget.__finishSearch" id="PipPackagesWidget.__finishSearch" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__finishSearch" />
+      <keyword name="PipPackagesWidget.__generateConstraints" id="PipPackagesWidget.__generateConstraints" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__generateConstraints" />
       <keyword name="PipPackagesWidget.__generateRequirements" id="PipPackagesWidget.__generateRequirements" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__generateRequirements" />
       <keyword name="PipPackagesWidget.__initPipMenu" id="PipPackagesWidget.__initPipMenu" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__initPipMenu" />
       <keyword name="PipPackagesWidget.__installLocalPackage" id="PipPackagesWidget.__installLocalPackage" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__installLocalPackage" />
--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipFreezeDialog.html	Sun Jul 17 18:47:23 2022 +0200
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipFreezeDialog.html	Sun Jul 17 18:48:09 2022 +0200
@@ -24,6 +24,10 @@
 <td><a href="#PipFreezeDialog">PipFreezeDialog</a></td>
 <td>Class implementing a dialog to generate a requirements file.</td>
 </tr>
+<tr>
+<td><a href="#PipFreezeDialogModes">PipFreezeDialogModes</a></td>
+<td>Class defining the various dialog modes.</td>
+</tr>
 </table>
 <h3>Functions</h3>
 
@@ -131,7 +135,7 @@
 
 <a NAME="PipFreezeDialog.__init__" ID="PipFreezeDialog.__init__"></a>
 <h4>PipFreezeDialog (Constructor)</h4>
-<b>PipFreezeDialog</b>(<i>pip, parent=None</i>)
+<b>PipFreezeDialog</b>(<i>pip, mode=PipFreezeDialogModes.Requirements, parent=None</i>)
 
 <p>
         Constructor
@@ -142,9 +146,13 @@
 <dd>
 reference to the master object
 </dd>
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>mode</i> (PipFreezeDialogModes (optional))</dt>
 <dd>
-reference to the parent widget
+dialog mod (defaults to PipFreezeDialogModes.Requirements)
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None
 </dd>
 </dl>
 <a NAME="PipFreezeDialog.__refresh" ID="PipFreezeDialog.__refresh"></a>
@@ -299,4 +307,36 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
+<hr />
+<a NAME="PipFreezeDialogModes" ID="PipFreezeDialogModes"></a>
+<h2>PipFreezeDialogModes</h2>
+
+<p>
+    Class defining the various dialog modes.
+</p>
+<h3>Derived from</h3>
+enum.Enum
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>Constraints</td></tr><tr><td>Requirements</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
 </body></html>
\ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Sun Jul 17 18:47:23 2022 +0200
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Sun Jul 17 18:48:09 2022 +0200
@@ -103,6 +103,10 @@
 <td>Private slot performing the search finishing actions.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.__generateConstraints">__generateConstraints</a></td>
+<td>Private slot to generate the contents for a constraints file.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.__generateRequirements">__generateRequirements</a></td>
 <td>Private slot to generate the contents for a requirements file.</td>
 </tr>
@@ -544,6 +548,13 @@
 <p>
         Private slot performing the search finishing actions.
 </p>
+<a NAME="PipPackagesWidget.__generateConstraints" ID="PipPackagesWidget.__generateConstraints"></a>
+<h4>PipPackagesWidget.__generateConstraints</h4>
+<b>__generateConstraints</b>(<i></i>)
+
+<p>
+        Private slot to generate the contents for a constraints file.
+</p>
 <a NAME="PipPackagesWidget.__generateRequirements" ID="PipPackagesWidget.__generateRequirements"></a>
 <h4>PipPackagesWidget.__generateRequirements</h4>
 <b>__generateRequirements</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html	Sun Jul 17 18:47:23 2022 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html	Sun Jul 17 18:48:09 2022 +0200
@@ -1330,20 +1330,13 @@
 </dl>
 <a NAME="Hg.hgGraftAbort" ID="Hg.hgGraftAbort"></a>
 <h4>Hg.hgGraftAbort</h4>
-<b>hgGraftAbort</b>(<i>path</i>)
+<b>hgGraftAbort</b>(<i></i>)
 
 <p>
         Public method to abort an interrupted copying session and perform
         a rollback.
 </p>
 <dl>
-
-<dt><i>path</i> (str)</dt>
-<dd>
-directory name of the project
-</dd>
-</dl>
-<dl>
 <dt>Return:</dt>
 <dd>
 flag indicating that the project should be reread
@@ -1357,19 +1350,12 @@
 </dl>
 <a NAME="Hg.hgGraftContinue" ID="Hg.hgGraftContinue"></a>
 <h4>Hg.hgGraftContinue</h4>
-<b>hgGraftContinue</b>(<i>path</i>)
+<b>hgGraftContinue</b>(<i></i>)
 
 <p>
         Public method to continue copying changesets from another branch.
 </p>
 <dl>
-
-<dt><i>path</i> (str)</dt>
-<dd>
-directory name of the project
-</dd>
-</dl>
-<dl>
 <dt>Return:</dt>
 <dd>
 flag indicating that the project should be reread
@@ -1383,19 +1369,12 @@
 </dl>
 <a NAME="Hg.hgGraftStop" ID="Hg.hgGraftStop"></a>
 <h4>Hg.hgGraftStop</h4>
-<b>hgGraftStop</b>(<i>path</i>)
+<b>hgGraftStop</b>(<i></i>)
 
 <p>
         Public method to stop an interrupted copying session.
 </p>
 <dl>
-
-<dt><i>path</i> (str)</dt>
-<dd>
-directory name of the project
-</dd>
-</dl>
-<dl>
 <dt>Return:</dt>
 <dd>
 flag indicating that the project should be reread

eric ide

mercurial