Fixed some forgotten source code documentation.

Sun, 31 Dec 2017 16:48:22 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 31 Dec 2017 16:48:22 +0100
changeset 6047
39586a2de99d
parent 6046
a291657f7bbd
child 6048
82ad8ec9548c

Fixed some forgotten source code documentation.

Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Helpviewer.PageScreenDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.StripExtension.HgStripDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Preferences.ConfigurationPages.EditorDocViewerPage.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Preferences.ConfigurationPages.WebBrowserPage.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.WebBrowser.PageScreenDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.WebBrowser.Session.SessionManagerDialog.html file | annotate | diff | comparison | revisions
Helpviewer/PageScreenDialog.py file | annotate | diff | comparison | revisions
Plugins/UiExtensionPlugins/PipInterface/PipPackageDetailsDialog.py file | annotate | diff | comparison | revisions
Plugins/UiExtensionPlugins/PipInterface/PipPackagesInputDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgExportDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/StripExtension/HgStripDialog.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorDocViewerPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/WebBrowserPage.py file | annotate | diff | comparison | revisions
WebBrowser/PageScreenDialog.py file | annotate | diff | comparison | revisions
WebBrowser/Session/SessionManagerDialog.py file | annotate | diff | comparison | revisions
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Source/eric6.Helpviewer.PageScreenDialog.html	Sun Dec 31 15:07:07 2017 +0100
+++ b/Documentation/Source/eric6.Helpviewer.PageScreenDialog.html	Sun Dec 31 16:48:22 2017 +0100
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#PageScreenDialog">PageScreenDialog</a></td>
-<td>Class documentation goes here.</td>
+<td>Class implementing a dialog to save a screenshot of a web page.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -42,7 +42,7 @@
 <a NAME="PageScreenDialog" ID="PageScreenDialog"></a>
 <h2>PageScreenDialog</h2>
 <p>
-    Class documentation goes here.
+    Class implementing a dialog to save a screenshot of a web page.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_PageScreenDialog
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html	Sun Dec 31 15:07:07 2017 +0100
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html	Sun Dec 31 16:48:22 2017 +0100
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#PipPackageDetailsDialog">PipPackageDetailsDialog</a></td>
-<td>Class documentation goes here.</td>
+<td>Class implementing a dialog to show details about a package.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -42,7 +42,7 @@
 <a NAME="PipPackageDetailsDialog" ID="PipPackageDetailsDialog"></a>
 <h2>PipPackageDetailsDialog</h2>
 <p>
-    Class documentation goes here.
+    Class implementing a dialog to show details about a package.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_PipPackageDetailsDialog
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html	Sun Dec 31 15:07:07 2017 +0100
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html	Sun Dec 31 16:48:22 2017 +0100
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#PipPackagesInputDialog">PipPackagesInputDialog</a></td>
-<td>Class documentation goes here.</td>
+<td>Class implementing a dialog to enter package specifications.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -42,7 +42,7 @@
 <a NAME="PipPackagesInputDialog" ID="PipPackagesInputDialog"></a>
 <h2>PipPackagesInputDialog</h2>
 <p>
-    Class documentation goes here.
+    Class implementing a dialog to enter package specifications.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_PipPackagesInputDialog
--- a/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html	Sun Dec 31 15:07:07 2017 +0100
+++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html	Sun Dec 31 16:48:22 2017 +0100
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#HgExportDialog">HgExportDialog</a></td>
-<td>Class documentation goes here.</td>
+<td>Class implementing a dialog to enter data for the Mercurial export command.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -42,7 +42,7 @@
 <a NAME="HgExportDialog" ID="HgExportDialog"></a>
 <h2>HgExportDialog</h2>
 <p>
-    Class documentation goes here.
+    Class implementing a dialog to enter data for the Mercurial export command.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_HgExportDialog
--- a/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.StripExtension.HgStripDialog.html	Sun Dec 31 15:07:07 2017 +0100
+++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.StripExtension.HgStripDialog.html	Sun Dec 31 16:48:22 2017 +0100
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#HgStripDialog">HgStripDialog</a></td>
-<td>Class documentation goes here.</td>
+<td>Class implementing a dialog to enter the data to strip changesets.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -42,7 +42,7 @@
 <a NAME="HgStripDialog" ID="HgStripDialog"></a>
 <h2>HgStripDialog</h2>
 <p>
-    Class documentation goes here.
+    Class implementing a dialog to enter the data to strip changesets.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_HgStripDialog
--- a/Documentation/Source/eric6.Preferences.ConfigurationPages.EditorDocViewerPage.html	Sun Dec 31 15:07:07 2017 +0100
+++ b/Documentation/Source/eric6.Preferences.ConfigurationPages.EditorDocViewerPage.html	Sun Dec 31 16:48:22 2017 +0100
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#EditorDocViewerPage">EditorDocViewerPage</a></td>
-<td>Class documentation goes here.</td>
+<td>Class implementing the Editor Documentation Viewer configuration page.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -45,7 +45,7 @@
 <a NAME="EditorDocViewerPage" ID="EditorDocViewerPage"></a>
 <h2>EditorDocViewerPage</h2>
 <p>
-    Class documentation goes here.
+    Class implementing the Editor Documentation Viewer configuration page.
 </p>
 <h3>Derived from</h3>
 ConfigurationPageBase, Ui_EditorDocViewerPage
--- a/Documentation/Source/eric6.Preferences.ConfigurationPages.WebBrowserPage.html	Sun Dec 31 15:07:07 2017 +0100
+++ b/Documentation/Source/eric6.Preferences.ConfigurationPages.WebBrowserPage.html	Sun Dec 31 16:48:22 2017 +0100
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#WebBrowserPage">WebBrowserPage</a></td>
-<td>Class documentation goes here.</td>
+<td>Class implementing the  Web Browser configuration page.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -45,7 +45,7 @@
 <a NAME="WebBrowserPage" ID="WebBrowserPage"></a>
 <h2>WebBrowserPage</h2>
 <p>
-    Class documentation goes here.
+    Class implementing the  Web Browser configuration page.
 </p>
 <h3>Derived from</h3>
 ConfigurationPageBase, Ui_WebBrowserPage
--- a/Documentation/Source/eric6.WebBrowser.PageScreenDialog.html	Sun Dec 31 15:07:07 2017 +0100
+++ b/Documentation/Source/eric6.WebBrowser.PageScreenDialog.html	Sun Dec 31 16:48:22 2017 +0100
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#PageScreenDialog">PageScreenDialog</a></td>
-<td>Class documentation goes here.</td>
+<td>Class implementing a dialog to save a screenshot of a web page.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -42,7 +42,7 @@
 <a NAME="PageScreenDialog" ID="PageScreenDialog"></a>
 <h2>PageScreenDialog</h2>
 <p>
-    Class documentation goes here.
+    Class implementing a dialog to save a screenshot of a web page.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_PageScreenDialog
--- a/Documentation/Source/eric6.WebBrowser.Session.SessionManagerDialog.html	Sun Dec 31 15:07:07 2017 +0100
+++ b/Documentation/Source/eric6.WebBrowser.Session.SessionManagerDialog.html	Sun Dec 31 16:48:22 2017 +0100
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#SessionManagerDialog">SessionManagerDialog</a></td>
-<td>Class documentation goes here.</td>
+<td>Class implementing a dialog to manage sessions.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -42,7 +42,7 @@
 <a NAME="SessionManagerDialog" ID="SessionManagerDialog"></a>
 <h2>SessionManagerDialog</h2>
 <p>
-    Class documentation goes here.
+    Class implementing a dialog to manage sessions.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_SessionManagerDialog
--- a/Helpviewer/PageScreenDialog.py	Sun Dec 31 15:07:07 2017 +0100
+++ b/Helpviewer/PageScreenDialog.py	Sun Dec 31 16:48:22 2017 +0100
@@ -20,7 +20,7 @@
 
 class PageScreenDialog(QDialog, Ui_PageScreenDialog):
     """
-    Class documentation goes here.
+    Class implementing a dialog to save a screenshot of a web page.
     """
     def __init__(self, view, visibleOnly=False, parent=None):
         """
--- a/Plugins/UiExtensionPlugins/PipInterface/PipPackageDetailsDialog.py	Sun Dec 31 15:07:07 2017 +0100
+++ b/Plugins/UiExtensionPlugins/PipInterface/PipPackageDetailsDialog.py	Sun Dec 31 16:48:22 2017 +0100
@@ -22,7 +22,7 @@
 
 class PipPackageDetailsDialog(QDialog, Ui_PipPackageDetailsDialog):
     """
-    Class documentation goes here.
+    Class implementing a dialog to show details about a package.
     """
     def __init__(self, detailsData, downloadsData, parent=None):
         """
--- a/Plugins/UiExtensionPlugins/PipInterface/PipPackagesInputDialog.py	Sun Dec 31 15:07:07 2017 +0100
+++ b/Plugins/UiExtensionPlugins/PipInterface/PipPackagesInputDialog.py	Sun Dec 31 16:48:22 2017 +0100
@@ -17,7 +17,7 @@
 
 class PipPackagesInputDialog(QDialog, Ui_PipPackagesInputDialog):
     """
-    Class documentation goes here.
+    Class implementing a dialog to enter package specifications.
     """
     def __init__(self, plugin, title, parent=None):
         """
--- a/Plugins/VcsPlugins/vcsMercurial/HgExportDialog.py	Sun Dec 31 15:07:07 2017 +0100
+++ b/Plugins/VcsPlugins/vcsMercurial/HgExportDialog.py	Sun Dec 31 16:48:22 2017 +0100
@@ -21,7 +21,7 @@
 
 class HgExportDialog(QDialog, Ui_HgExportDialog):
     """
-    Class documentation goes here.
+    Class implementing a dialog to enter data for the Mercurial export command.
     """
     def __init__(self, parent=None):
         """
--- a/Plugins/VcsPlugins/vcsMercurial/StripExtension/HgStripDialog.py	Sun Dec 31 15:07:07 2017 +0100
+++ b/Plugins/VcsPlugins/vcsMercurial/StripExtension/HgStripDialog.py	Sun Dec 31 16:48:22 2017 +0100
@@ -17,7 +17,7 @@
 
 class HgStripDialog(QDialog, Ui_HgStripDialog):
     """
-    Class documentation goes here.
+    Class implementing a dialog to enter the data to strip changesets.
     """
     def __init__(self, tagsList, branchesList, bookmarksList=None, rev="",
                  parent=None):
--- a/Preferences/ConfigurationPages/EditorDocViewerPage.py	Sun Dec 31 15:07:07 2017 +0100
+++ b/Preferences/ConfigurationPages/EditorDocViewerPage.py	Sun Dec 31 16:48:22 2017 +0100
@@ -19,7 +19,7 @@
 
 class EditorDocViewerPage(ConfigurationPageBase, Ui_EditorDocViewerPage):
     """
-    Class documentation goes here.
+    Class implementing the Editor Documentation Viewer configuration page.
     """
     def __init__(self, parent=None):
         """
--- a/Preferences/ConfigurationPages/WebBrowserPage.py	Sun Dec 31 15:07:07 2017 +0100
+++ b/Preferences/ConfigurationPages/WebBrowserPage.py	Sun Dec 31 16:48:22 2017 +0100
@@ -20,7 +20,7 @@
 
 class WebBrowserPage(ConfigurationPageBase, Ui_WebBrowserPage):
     """
-    Class documentation goes here.
+    Class implementing the  Web Browser configuration page.
     """
     def __init__(self, configDialog):
         """
--- a/WebBrowser/PageScreenDialog.py	Sun Dec 31 15:07:07 2017 +0100
+++ b/WebBrowser/PageScreenDialog.py	Sun Dec 31 16:48:22 2017 +0100
@@ -20,7 +20,7 @@
 
 class PageScreenDialog(QDialog, Ui_PageScreenDialog):
     """
-    Class documentation goes here.
+    Class implementing a dialog to save a screenshot of a web page.
     """
     def __init__(self, view, visibleOnly=False, parent=None):
         """
--- a/WebBrowser/Session/SessionManagerDialog.py	Sun Dec 31 15:07:07 2017 +0100
+++ b/WebBrowser/Session/SessionManagerDialog.py	Sun Dec 31 16:48:22 2017 +0100
@@ -20,7 +20,7 @@
 
 class SessionManagerDialog(QDialog, Ui_SessionManagerDialog):
     """
-    Class documentation goes here.
+    Class implementing a dialog to manage sessions.
     """
     SessionFileRole = Qt.UserRole
     BackupSessionRole = Qt.UserRole + 1

eric ide

mercurial