Updated source documentation. eric7

Sat, 27 May 2023 18:30:00 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 27 May 2023 18:30:00 +0200
branch
eric7
changeset 10076
649f7ca537ea
parent 10075
3b2dc7fefbfc
child 10077
b8396ae5c2c2

Updated source documentation.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/DataViews/CodeMetricsDialog.py file | annotate | diff | comparison | revisions
src/eric7/DataViews/PyCoverageDialog.py file | annotate | diff | comparison | revisions
src/eric7/DataViews/PyProfileDialog.py 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.DataViews.CodeMetricsDialog.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.DataViews.PyCoverageDialog.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.DataViews.PyProfileDialog.html file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Sat May 27 18:16:10 2023 +0200
+++ b/src/eric7/APIs/Python3/eric7.api	Sat May 27 18:30:00 2023 +0200
@@ -248,11 +248,13 @@
 eric7.DataViews.CodeMetrics.SourceStat?1()
 eric7.DataViews.CodeMetrics.analyze?4(filename, total)
 eric7.DataViews.CodeMetrics.summarize?4(total, key, value)
+eric7.DataViews.CodeMetricsDialog.CodeMetricsDialog.closeEvent?4(evt)
 eric7.DataViews.CodeMetricsDialog.CodeMetricsDialog.on_buttonBox_clicked?4(button)
 eric7.DataViews.CodeMetricsDialog.CodeMetricsDialog.on_startButton_clicked?4()
 eric7.DataViews.CodeMetricsDialog.CodeMetricsDialog.prepare?4(fileList)
 eric7.DataViews.CodeMetricsDialog.CodeMetricsDialog.start?4(fn)
 eric7.DataViews.CodeMetricsDialog.CodeMetricsDialog?1(parent=None)
+eric7.DataViews.PyCoverageDialog.PyCoverageDialog.closeEvent?4(evt)
 eric7.DataViews.PyCoverageDialog.PyCoverageDialog.on_buttonBox_clicked?4(button)
 eric7.DataViews.PyCoverageDialog.PyCoverageDialog.on_reloadButton_clicked?4()
 eric7.DataViews.PyCoverageDialog.PyCoverageDialog.on_resultList_itemActivated?4(item, column)
@@ -266,6 +268,7 @@
 eric7.DataViews.PyCoverageJsonReportDialog.PyCoverageJsonReportDialog.getData?4()
 eric7.DataViews.PyCoverageJsonReportDialog.PyCoverageJsonReportDialog.on_outputFilePicker_textChanged?4(filename)
 eric7.DataViews.PyCoverageJsonReportDialog.PyCoverageJsonReportDialog?1(defaultDirectory, parent=None)
+eric7.DataViews.PyProfileDialog.PyProfileDialog.closeEvent?4(evt)
 eric7.DataViews.PyProfileDialog.PyProfileDialog.on_buttonBox_clicked?4(button)
 eric7.DataViews.PyProfileDialog.PyProfileDialog.start?4(pfn, fn=None)
 eric7.DataViews.PyProfileDialog.PyProfileDialog?1(parent=None)
--- a/src/eric7/DataViews/CodeMetricsDialog.py	Sat May 27 18:16:10 2023 +0200
+++ b/src/eric7/DataViews/CodeMetricsDialog.py	Sat May 27 18:30:00 2023 +0200
@@ -252,7 +252,7 @@
 
     def closeEvent(self, evt):
         """
-        Public method to handle the close event.
+        Protected method to handle the close event.
 
         @param evt reference to the close event
         @type QCloseEvent
--- a/src/eric7/DataViews/PyCoverageDialog.py	Sat May 27 18:16:10 2023 +0200
+++ b/src/eric7/DataViews/PyCoverageDialog.py	Sat May 27 18:30:00 2023 +0200
@@ -303,7 +303,7 @@
 
     def closeEvent(self, evt):
         """
-        Public method to handle the close event.
+        Protected method to handle the close event.
 
         @param evt reference to the close event
         @type QCloseEvent
--- a/src/eric7/DataViews/PyProfileDialog.py	Sat May 27 18:16:10 2023 +0200
+++ b/src/eric7/DataViews/PyProfileDialog.py	Sat May 27 18:30:00 2023 +0200
@@ -306,7 +306,7 @@
 
     def closeEvent(self, evt):
         """
-        Public method to handle the close event.
+        Protected method to handle the close event.
 
         @param evt reference to the close event
         @type QCloseEvent
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Sat May 27 18:16:10 2023 +0200
+++ b/src/eric7/Documentation/Help/source.qhp	Sat May 27 18:30:00 2023 +0200
@@ -3086,6 +3086,7 @@
       <keyword name="CodeMetricsDialog.__resultCollapse" id="CodeMetricsDialog.__resultCollapse" ref="eric7.DataViews.CodeMetricsDialog.html#CodeMetricsDialog.__resultCollapse" />
       <keyword name="CodeMetricsDialog.__resultExpand" id="CodeMetricsDialog.__resultExpand" ref="eric7.DataViews.CodeMetricsDialog.html#CodeMetricsDialog.__resultExpand" />
       <keyword name="CodeMetricsDialog.__showContextMenu" id="CodeMetricsDialog.__showContextMenu" ref="eric7.DataViews.CodeMetricsDialog.html#CodeMetricsDialog.__showContextMenu" />
+      <keyword name="CodeMetricsDialog.closeEvent" id="CodeMetricsDialog.closeEvent" ref="eric7.DataViews.CodeMetricsDialog.html#CodeMetricsDialog.closeEvent" />
       <keyword name="CodeMetricsDialog.on_buttonBox_clicked" id="CodeMetricsDialog.on_buttonBox_clicked" ref="eric7.DataViews.CodeMetricsDialog.html#CodeMetricsDialog.on_buttonBox_clicked" />
       <keyword name="CodeMetricsDialog.on_startButton_clicked" id="CodeMetricsDialog.on_startButton_clicked" ref="eric7.DataViews.CodeMetricsDialog.html#CodeMetricsDialog.on_startButton_clicked" />
       <keyword name="CodeMetricsDialog.prepare" id="CodeMetricsDialog.prepare" ref="eric7.DataViews.CodeMetricsDialog.html#CodeMetricsDialog.prepare" />
@@ -13440,6 +13441,7 @@
       <keyword name="PyCoverageDialog.__openFile" id="PyCoverageDialog.__openFile" ref="eric7.DataViews.PyCoverageDialog.html#PyCoverageDialog.__openFile" />
       <keyword name="PyCoverageDialog.__prepareReportGeneration" id="PyCoverageDialog.__prepareReportGeneration" ref="eric7.DataViews.PyCoverageDialog.html#PyCoverageDialog.__prepareReportGeneration" />
       <keyword name="PyCoverageDialog.__showContextMenu" id="PyCoverageDialog.__showContextMenu" ref="eric7.DataViews.PyCoverageDialog.html#PyCoverageDialog.__showContextMenu" />
+      <keyword name="PyCoverageDialog.closeEvent" id="PyCoverageDialog.closeEvent" ref="eric7.DataViews.PyCoverageDialog.html#PyCoverageDialog.closeEvent" />
       <keyword name="PyCoverageDialog.on_buttonBox_clicked" id="PyCoverageDialog.on_buttonBox_clicked" ref="eric7.DataViews.PyCoverageDialog.html#PyCoverageDialog.on_buttonBox_clicked" />
       <keyword name="PyCoverageDialog.on_reloadButton_clicked" id="PyCoverageDialog.on_reloadButton_clicked" ref="eric7.DataViews.PyCoverageDialog.html#PyCoverageDialog.on_reloadButton_clicked" />
       <keyword name="PyCoverageDialog.on_resultList_itemActivated" id="PyCoverageDialog.on_resultList_itemActivated" ref="eric7.DataViews.PyCoverageDialog.html#PyCoverageDialog.on_resultList_itemActivated" />
@@ -13503,6 +13505,7 @@
       <keyword name="PyProfileDialog.__resortResultList" id="PyProfileDialog.__resortResultList" ref="eric7.DataViews.PyProfileDialog.html#PyProfileDialog.__resortResultList" />
       <keyword name="PyProfileDialog.__showContextMenu" id="PyProfileDialog.__showContextMenu" ref="eric7.DataViews.PyProfileDialog.html#PyProfileDialog.__showContextMenu" />
       <keyword name="PyProfileDialog.__unfinish" id="PyProfileDialog.__unfinish" ref="eric7.DataViews.PyProfileDialog.html#PyProfileDialog.__unfinish" />
+      <keyword name="PyProfileDialog.closeEvent" id="PyProfileDialog.closeEvent" ref="eric7.DataViews.PyProfileDialog.html#PyProfileDialog.closeEvent" />
       <keyword name="PyProfileDialog.on_buttonBox_clicked" id="PyProfileDialog.on_buttonBox_clicked" ref="eric7.DataViews.PyProfileDialog.html#PyProfileDialog.on_buttonBox_clicked" />
       <keyword name="PyProfileDialog.start" id="PyProfileDialog.start" ref="eric7.DataViews.PyProfileDialog.html#PyProfileDialog.start" />
       <keyword name="PyRegExpWizard" id="PyRegExpWizard" ref="eric7.Plugins.PluginWizardPyRegExp.html#PyRegExpWizard" />
--- a/src/eric7/Documentation/Source/eric7.DataViews.CodeMetricsDialog.html	Sat May 27 18:16:10 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.DataViews.CodeMetricsDialog.html	Sat May 27 18:30:00 2023 +0200
@@ -95,6 +95,10 @@
 <td>Private slot to show the context menu of the listview.</td>
 </tr>
 <tr>
+<td><a href="#CodeMetricsDialog.closeEvent">closeEvent</a></td>
+<td>Protected method to handle the close event.</td>
+</tr>
+<tr>
 <td><a href="#CodeMetricsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
 <td>Private slot called by a button of the button box clicked.</td>
 </tr>
@@ -251,6 +255,20 @@
 the position of the mouse pointer (QPoint)
 </dd>
 </dl>
+<a NAME="CodeMetricsDialog.closeEvent" ID="CodeMetricsDialog.closeEvent"></a>
+<h4>CodeMetricsDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method to handle the close event.
+</p>
+<dl>
+
+<dt><i>evt</i> (QCloseEvent)</dt>
+<dd>
+reference to the close event
+</dd>
+</dl>
 <a NAME="CodeMetricsDialog.on_buttonBox_clicked" ID="CodeMetricsDialog.on_buttonBox_clicked"></a>
 <h4>CodeMetricsDialog.on_buttonBox_clicked</h4>
 <b>on_buttonBox_clicked</b>(<i>button</i>)
--- a/src/eric7/Documentation/Source/eric7.DataViews.PyCoverageDialog.html	Sat May 27 18:16:10 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.DataViews.PyCoverageDialog.html	Sat May 27 18:30:00 2023 +0200
@@ -107,6 +107,10 @@
 <td>Private slot to show the context menu of the listview.</td>
 </tr>
 <tr>
+<td><a href="#PyCoverageDialog.closeEvent">closeEvent</a></td>
+<td>Protected method to handle the close event.</td>
+</tr>
+<tr>
 <td><a href="#PyCoverageDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
 <td>Private slot called by a button of the button box clicked.</td>
 </tr>
@@ -296,6 +300,20 @@
 position of the mouse pointer
 </dd>
 </dl>
+<a NAME="PyCoverageDialog.closeEvent" ID="PyCoverageDialog.closeEvent"></a>
+<h4>PyCoverageDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method to handle the close event.
+</p>
+<dl>
+
+<dt><i>evt</i> (QCloseEvent)</dt>
+<dd>
+reference to the close event
+</dd>
+</dl>
 <a NAME="PyCoverageDialog.on_buttonBox_clicked" ID="PyCoverageDialog.on_buttonBox_clicked"></a>
 <h4>PyCoverageDialog.on_buttonBox_clicked</h4>
 <b>on_buttonBox_clicked</b>(<i>button</i>)
--- a/src/eric7/Documentation/Source/eric7.DataViews.PyProfileDialog.html	Sat May 27 18:16:10 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.DataViews.PyProfileDialog.html	Sat May 27 18:30:00 2023 +0200
@@ -189,6 +189,10 @@
 <td>Private slot called to revert the effects of the __finish slot.</td>
 </tr>
 <tr>
+<td><a href="#PyProfileDialog.closeEvent">closeEvent</a></td>
+<td>Protected method to handle the close event.</td>
+</tr>
+<tr>
 <td><a href="#PyProfileDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
 <td>Private slot called by a button of the button box clicked.</td>
 </tr>
@@ -357,6 +361,20 @@
 <p>
         Private slot called to revert the effects of the __finish slot.
 </p>
+<a NAME="PyProfileDialog.closeEvent" ID="PyProfileDialog.closeEvent"></a>
+<h4>PyProfileDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method to handle the close event.
+</p>
+<dl>
+
+<dt><i>evt</i> (QCloseEvent)</dt>
+<dd>
+reference to the close event
+</dd>
+</dl>
 <a NAME="PyProfileDialog.on_buttonBox_clicked" ID="PyProfileDialog.on_buttonBox_clicked"></a>
 <h4>PyProfileDialog.on_buttonBox_clicked</h4>
 <b>on_buttonBox_clicked</b>(<i>button</i>)

eric ide

mercurial