Sun, 29 Sep 2013 18:23:27 +0200
Regenerated source docu after corrections.
--- a/APIs/Python3/eric5.api Sun Sep 29 18:22:08 2013 +0200 +++ b/APIs/Python3/eric5.api Sun Sep 29 18:23:27 2013 +0200 @@ -3366,8 +3366,8 @@ eric5.IconEditor.cursors.cursors_rc.qt_resource_struct?7 eric5.MultiProject.AddProjectDialog.AddProjectDialog.getData?4() eric5.MultiProject.AddProjectDialog.AddProjectDialog.on_fileButton_clicked?4() -eric5.MultiProject.AddProjectDialog.AddProjectDialog.on_filenameEdit_textChanged?4(p0) -eric5.MultiProject.AddProjectDialog.AddProjectDialog.on_nameEdit_textChanged?4(p0) +eric5.MultiProject.AddProjectDialog.AddProjectDialog.on_filenameEdit_textChanged?4(txt) +eric5.MultiProject.AddProjectDialog.AddProjectDialog.on_nameEdit_textChanged?4(txt) eric5.MultiProject.AddProjectDialog.AddProjectDialog?1(parent=None, startdir=None, project=None) eric5.MultiProject.MultiProject.MultiProject.addE5Actions?4(actions) eric5.MultiProject.MultiProject.MultiProject.addProject?4(startdir=None) @@ -3960,7 +3960,7 @@ eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog.on_qtHelpFolderEdit_textChanged?4(txt) eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog.on_qtHelpGroup_toggled?4(enabled) eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged?4(txt) -eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog.on_qtHelpTitleEdit_textChanged?4(p0) +eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog.on_qtHelpTitleEdit_textChanged?4(txt) eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog?1(project, parms=None, parent=None) eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.EricdocExecDialog.on_buttonBox_clicked?4(button) eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.EricdocExecDialog.start?4(args, fn) @@ -4495,8 +4495,8 @@ eric5.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.HgExportDialog.getParameters?4() eric5.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.HgExportDialog.on_changesetsEdit_textChanged?4() eric5.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.HgExportDialog.on_directoryButton_clicked?4() -eric5.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.HgExportDialog.on_directoryEdit_textChanged?4(p0) -eric5.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.HgExportDialog.on_patternEdit_textChanged?4(p0) +eric5.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.HgExportDialog.on_directoryEdit_textChanged?4(txt) +eric5.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.HgExportDialog.on_patternEdit_textChanged?4(txt) eric5.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.HgExportDialog?1(parent=None) eric5.Plugins.VcsPlugins.vcsMercurial.HgExtension.HgExtension.shutdown?4() eric5.Plugins.VcsPlugins.vcsMercurial.HgExtension.HgExtension?1(vcs) @@ -5499,16 +5499,16 @@ eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.getCode?4(indLevel, indString) eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_bTest_clicked?4() eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_buttonBox_clicked?4(button) -eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rAboutQt_toggled?4(checked) -eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rAbout_toggled?4(checked) -eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rCritical_toggled?4(checked) -eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rInformation_toggled?4(checked) -eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rOkToClearData_toggled?4(checked) -eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rQuestion_toggled?4(checked) -eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rRetryAbort_toggled?4(checked) -eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rStandard_toggled?4(checked) -eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rWarning_toggled?4(checked) -eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rYesNo_toggled?4(checked) +eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rAboutQt_toggled?4(on) +eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rAbout_toggled?4(on) +eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rCritical_toggled?4(on) +eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rInformation_toggled?4(on) +eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rOkToClearData_toggled?4(on) +eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rQuestion_toggled?4(on) +eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rRetryAbort_toggled?4(on) +eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rStandard_toggled?4(on) +eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rWarning_toggled?4(on) +eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog.on_rYesNo_toggled?4(on) eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.E5MessageBoxWizardDialog?1(parent=None) eric5.Plugins.WizardPlugins.FileDialogWizard.FileDialogWizardDialog.FileDialogWizardDialog.getCode?4(indLevel, indString) eric5.Plugins.WizardPlugins.FileDialogWizard.FileDialogWizardDialog.FileDialogWizardDialog.on_bTest_clicked?4() @@ -7412,7 +7412,7 @@ eric5.SqlBrowser.SqlBrowserWidget.SqlBrowserWidget.updateActions?4() eric5.SqlBrowser.SqlBrowserWidget.SqlBrowserWidget?1(parent=None) eric5.SqlBrowser.SqlConnectionDialog.SqlConnectionDialog.getData?4() -eric5.SqlBrowser.SqlConnectionDialog.SqlConnectionDialog.on_databaseEdit_textChanged?4(p0) +eric5.SqlBrowser.SqlConnectionDialog.SqlConnectionDialog.on_databaseEdit_textChanged?4(txt) eric5.SqlBrowser.SqlConnectionDialog.SqlConnectionDialog.on_databaseFileButton_clicked?4() eric5.SqlBrowser.SqlConnectionDialog.SqlConnectionDialog.on_driverCombo_activated?4(txt) eric5.SqlBrowser.SqlConnectionDialog.SqlConnectionDialog?1(parent=None) @@ -7859,7 +7859,7 @@ eric5.UI.NumbersWidget.NumbersWidget.on_octEdit_textChanged?4(txt) eric5.UI.NumbersWidget.NumbersWidget.on_octInButton_clicked?4() eric5.UI.NumbersWidget.NumbersWidget.on_octOutButton_clicked?4() -eric5.UI.NumbersWidget.NumbersWidget.on_sizeBox_valueChanged?4(index) +eric5.UI.NumbersWidget.NumbersWidget.on_sizeBox_valueChanged?4(value) eric5.UI.NumbersWidget.NumbersWidget?1(parent=None) eric5.UI.PixmapCache.PixmapCache.addSearchPath?4(path) eric5.UI.PixmapCache.PixmapCache.getPixmap?4(key)
--- a/Documentation/Source/eric5.Cooperation.ChatWidget.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Cooperation.ChatWidget.html Sun Sep 29 18:23:27 2013 +0200 @@ -397,7 +397,12 @@ <b>getClient</b>(<i></i>) <p> Public method to get a reference to the cooperation client. -</p><a NAME="ChatWidget.on_cancelEditButton_clicked" ID="ChatWidget.on_cancelEditButton_clicked"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the cooperation client (CooperationClient) +</dd> +</dl><a NAME="ChatWidget.on_cancelEditButton_clicked" ID="ChatWidget.on_cancelEditButton_clicked"></a> <h4>ChatWidget.on_cancelEditButton_clicked</h4> <b>on_cancelEditButton_clicked</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Cooperation.Connection.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Cooperation.Connection.html Sun Sep 29 18:23:27 2013 +0200 @@ -302,6 +302,9 @@ <dt><i>message</i></dt> <dd> greeting message (string) +</dd><dt><i>serverPort</i></dt> +<dd> +port number to include in the message (integer) </dd> </dl><a NAME="Connection.timerEvent" ID="Connection.timerEvent"></a> <h4>Connection.timerEvent</h4>
--- a/Documentation/Source/eric5.DataViews.CodeMetrics.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DataViews.CodeMetrics.html Sun Sep 29 18:23:27 2013 +0200 @@ -52,7 +52,7 @@ <td>Module function used analyze the source of a Python file.</td> </tr><tr> <td><a href="#main">main</a></td> -<td>Modules main function used when called as a script.</td> +<td>Module main function used when called as a script.</td> </tr><tr> <td><a href="#summarize">summarize</a></td> <td>Module function used to collect overall statistics.</td> @@ -182,6 +182,11 @@ <dd> the token to be processed (Token) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid indentation level +</dd> </dl><a NAME="SourceStat.dump" ID="SourceStat.dump"></a> <h4>SourceStat.dump</h4> <b>dump</b>(<i></i>) @@ -276,7 +281,7 @@ <p> Constructor </p><dl> -<dt><i>**kw</i></dt> +<dt><i>**kw=</i></dt> <dd> list of key, value pairs </dd> @@ -308,10 +313,10 @@ <h2>main</h2> <b>main</b>(<i></i>) <p> - Modules main function used when called as a script. + Module main function used when called as a script. </p><p> - This function simply loops over all files given on the commandline - and collects the individual and overall source code statistics. + Loop over all files given on the command line and collect the individual + and overall source code statistics. </p> <div align="right"><a href="#top">Up</a></div> <hr /><hr />
--- a/Documentation/Source/eric5.DataViews.PyProfileDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DataViews.PyProfileDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -81,6 +81,11 @@ <dd> item to operate on (ProfileTreeWidgetItem) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +comparison value for the first column (integer) +</dd> </dl><a NAME="ProfileTreeWidgetItem.__lt__" ID="ProfileTreeWidgetItem.__lt__"></a> <h4>ProfileTreeWidgetItem.__lt__</h4> <b>__lt__</b>(<i>other</i>)
--- a/Documentation/Source/eric5.DebugClients.Python.AsyncFile.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python.AsyncFile.html Sun Sep 29 18:23:27 2013 +0200 @@ -148,6 +148,11 @@ <dd> the mode to be checked (string) </dd> +</dl><dl> +<dt>Raises <b>IOError</b>:</dt> +<dd> +raised to indicate a bad file descriptor +</dd> </dl><a NAME="AsyncFile.__nWrite" ID="AsyncFile.__nWrite"></a> <h4>AsyncFile.__nWrite</h4> <b>__nWrite</b>(<i>n</i>) @@ -287,6 +292,14 @@ <p> Public method to move the filepointer. </p><dl> +<dt><i>offset</i></dt> +<dd> +offset to seek for +</dd><dt><i>whence</i></dt> +<dd> +where to seek from +</dd> +</dl><dl> <dt>Raises <b>IOError</b>:</dt> <dd> This method is not supported and always raises an @@ -309,6 +322,11 @@ <p> Public method to truncate the file. </p><dl> +<dt><i>size</i></dt> +<dd> +size to truncate to (integer) +</dd> +</dl><dl> <dt>Raises <b>IOError</b>:</dt> <dd> This method is not supported and always raises an @@ -324,6 +342,11 @@ <dd> bytes to be written (string) </dd> +</dl><dl> +<dt>Raises <b>socket.error</b>:</dt> +<dd> +raised to indicate too many send attempts +</dd> </dl><a NAME="AsyncFile.writelines" ID="AsyncFile.writelines"></a> <h4>AsyncFile.writelines</h4> <b>writelines</b>(<i>list</i>)
--- a/Documentation/Source/eric5.DebugClients.Python.AsyncIO.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python.AsyncIO.html Sun Sep 29 18:23:27 2013 +0200 @@ -85,12 +85,7 @@ <b>AsyncIO</b>(<i></i>) <p> Constructor -</p><dl> -<dt><i>parent</i></dt> -<dd> -the optional parent of this object (QObject) (ignored) -</dd> -</dl><a NAME="AsyncIO.disconnect" ID="AsyncIO.disconnect"></a> +</p><a NAME="AsyncIO.disconnect" ID="AsyncIO.disconnect"></a> <h4>AsyncIO.disconnect</h4> <b>disconnect</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.DebugClients.Python.DebugBase.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python.DebugBase.html Sun Sep 29 18:23:27 2013 +0200 @@ -337,6 +337,11 @@ <dd> local trace function </dd> +</dl><dl> +<dt>Raises <b>bdb.BdbQuit</b>:</dt> +<dd> +raised to indicate the end of the debug session +</dd> </dl><a NAME="DebugBase.dispatch_line" ID="DebugBase.dispatch_line"></a> <h4>DebugBase.dispatch_line</h4> <b>dispatch_line</b>(<i>frame</i>) @@ -356,6 +361,11 @@ <dd> local trace function </dd> +</dl><dl> +<dt>Raises <b>bdb.BdbQuit</b>:</dt> +<dd> +raised to indicate the end of the debug session +</dd> </dl><a NAME="DebugBase.dispatch_return" ID="DebugBase.dispatch_return"></a> <h4>DebugBase.dispatch_return</h4> <b>dispatch_return</b>(<i>frame, arg</i>) @@ -374,6 +384,11 @@ <dd> local trace function </dd> +</dl><dl> +<dt>Raises <b>bdb.BdbQuit</b>:</dt> +<dd> +raised to indicate the end of the debug session +</dd> </dl><a NAME="DebugBase.fix_frame_filename" ID="DebugBase.fix_frame_filename"></a> <h4>DebugBase.fix_frame_filename</h4> <b>fix_frame_filename</b>(<i>frame</i>) @@ -395,6 +410,11 @@ <dd> the frame object </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +fixed up file name (string) +</dd> </dl><a NAME="DebugBase.getCurrentFrame" ID="DebugBase.getCurrentFrame"></a> <h4>DebugBase.getCurrentFrame</h4> <b>getCurrentFrame</b>(<i></i>) @@ -447,10 +467,10 @@ </p><dl> <dt><i>filename</i></dt> <dd> -the filename of the bp to retrieve (string) -</dd><dt><i>ineno</i></dt> +filename of the bp to retrieve (string) +</dd><dt><i>lineno</i></dt> <dd> -the linenumber of the bp to retrieve (integer) +linenumber of the bp to retrieve (integer) </dd> </dl><dl> <dt>Returns:</dt> @@ -467,6 +487,11 @@ <dd> expression of the watch expression to be cleared (string) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the watch point +</dd> </dl><a NAME="DebugBase.go" ID="DebugBase.go"></a> <h4>DebugBase.go</h4> <b>go</b>(<i>special</i>) @@ -498,13 +523,18 @@ </p><dl> <dt><i>frame</i></dt> <dd> -The current stack frame. +current stack frame. </dd><dt><i>event</i></dt> <dd> -The trace event (string) +trace event (string) </dd><dt><i>arg</i></dt> <dd> -The arguments +arguments +</dd> +</dl><dl> +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +raised to indicate too many recursions </dd> </dl><a NAME="DebugBase.setRecursionDepth" ID="DebugBase.setRecursionDepth"></a> <h4>DebugBase.setRecursionDepth</h4>
--- a/Documentation/Source/eric5.DebugClients.Python.DebugClientBase.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python.DebugClientBase.html Sun Sep 29 18:23:27 2013 +0200 @@ -122,7 +122,7 @@ <td>Private method to return the variables of a frame to the debug server.</td> </tr><tr> <td><a href="#DebugClientBase.__exceptionRaised">__exceptionRaised</a></td> -<td>Private method called in the case of an exception</td> +<td>Private method called in the case of an exception.</td> </tr><tr> <td><a href="#DebugClientBase.__formatQt4Variable">__formatQt4Variable</a></td> <td>Private method to produce a formated output of a simple Qt4/Qt5 type.</td> @@ -282,7 +282,7 @@ <h4>DebugClientBase.__exceptionRaised</h4> <b>__exceptionRaised</b>(<i></i>) <p> - Private method called in the case of an exception + Private method called in the case of an exception. </p><p> It ensures that the debug server is informed of the raised exception. </p><a NAME="DebugClientBase.__formatQt4Variable" ID="DebugClientBase.__formatQt4Variable"></a> @@ -466,11 +466,6 @@ non-zero, if we are attaching to the already started mainthread of the app </dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -The identifier of the created thread -</dd> </dl><a NAME="DebugClientBase.close" ID="DebugClientBase.close"></a> <h4>DebugClientBase.close</h4> <b>close</b>(<i>fd</i>) @@ -523,8 +518,14 @@ <h4>DebugClientBase.fork</h4> <b>fork</b>(<i></i>) <p> - Public method implementing a fork routine deciding which branch to follow. -</p><a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a> + Public method implementing a fork routine deciding which branch to + follow. +</p><dl> +<dt>Returns:</dt> +<dd> +process ID (integer) +</dd> +</dl><a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a> <h4>DebugClientBase.getCoding</h4> <b>getCoding</b>(<i></i>) <p> @@ -539,7 +540,12 @@ <b>getRunning</b>(<i></i>) <p> Public method to return the main script we are currently running. -</p><a NAME="DebugClientBase.handleLine" ID="DebugClientBase.handleLine"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating a running debug session (boolean) +</dd> +</dl><a NAME="DebugClientBase.handleLine" ID="DebugClientBase.handleLine"></a> <h4>DebugClientBase.handleLine</h4> <b>handleLine</b>(<i>line</i>) <p> @@ -734,7 +740,12 @@ <b>DebugClientFork</b>(<i></i>) <p> Replacement for the standard os.fork(). -</p> +</p><dl> +<dt>Returns:</dt> +<dd> +result of the fork() call +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="DebugClientInput" ID="DebugClientInput"></a> @@ -747,7 +758,12 @@ </p><dl> <dt><i>prompt</i></dt> <dd> -The prompt to be shown. (string) +prompt to be shown (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +result of the input() call </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -762,10 +778,15 @@ </p><dl> <dt><i>prompt</i></dt> <dd> -The prompt to be shown. (string) +prompt to be shown. (string) </dd><dt><i>echo</i></dt> <dd> -Flag indicating echoing of the input (boolean) +flag indicating echoing of the input (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +result of the raw_input() call </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.DebugClients.Python.FlexCompleter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python.FlexCompleter.html Sun Sep 29 18:23:27 2013 +0200 @@ -21,7 +21,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.DebugClients.Python.FlexCompleter</h1> <p> -Word completion for the eric5 shell +Word completion for the eric5 shell. </p><p> <h4>NOTE for eric5 variant</h4> </p><p> @@ -176,7 +176,12 @@ </p><dl> <dt><i>namespace</i></dt> <dd> -The namespace for the completer. +namespace for the completer +</dd> +</dl><dl> +<dt>Raises <b>TypeError</b>:</dt> +<dd> +raised to indicate a wrong namespace structure </dd> </dl><a NAME="Completer.attr_matches" ID="Completer.attr_matches"></a> <h4>Completer.attr_matches</h4>
--- a/Documentation/Source/eric5.DebugClients.Python.PyProfile.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python.PyProfile.html Sun Sep 29 18:23:27 2013 +0200 @@ -145,6 +145,11 @@ <dd> the frame object </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +fixed up file name (string) +</dd> </dl><a NAME="PyProfile.save" ID="PyProfile.save"></a> <h4>PyProfile.save</h4> <b>save</b>(<i></i>) @@ -158,7 +163,20 @@ </p><p> This is a variant of the one found in the standard Python profile.py calling fix_frame_filename above. -</p> +</p><dl> +<dt><i>frame</i></dt> +<dd> +reference to the call frame +</dd><dt><i>t</i></dt> +<dd> +arguments of the call +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a handled call +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.DebugClients.Python.eric5dbgstub.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python.eric5dbgstub.html Sun Sep 29 18:23:27 2013 +0200 @@ -63,6 +63,12 @@ <dd> flag indicating success (boolean) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid debugger kind + was requested +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr />
--- a/Documentation/Source/eric5.DebugClients.Python3.AsyncFile.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python3.AsyncFile.html Sun Sep 29 18:23:27 2013 +0200 @@ -157,6 +157,11 @@ <dd> the mode to be checked (string) </dd> +</dl><dl> +<dt>Raises <b>IOError</b>:</dt> +<dd> +raised to indicate a bad file descriptor +</dd> </dl><a NAME="AsyncFile.__nWrite" ID="AsyncFile.__nWrite"></a> <h4>AsyncFile.__nWrite</h4> <b>__nWrite</b>(<i>n</i>) @@ -376,6 +381,11 @@ <dd> bytes to be written (string) </dd> +</dl><dl> +<dt>Raises <b>socket.error</b>:</dt> +<dd> +raised to indicate too many send attempts +</dd> </dl><a NAME="AsyncFile.writelines" ID="AsyncFile.writelines"></a> <h4>AsyncFile.writelines</h4> <b>writelines</b>(<i>list</i>)
--- a/Documentation/Source/eric5.DebugClients.Python3.AsyncIO.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python3.AsyncIO.html Sun Sep 29 18:23:27 2013 +0200 @@ -85,12 +85,7 @@ <b>AsyncIO</b>(<i></i>) <p> Constructor -</p><dl> -<dt><i>parent</i></dt> -<dd> -the optional parent of this object (QObject) (ignored) -</dd> -</dl><a NAME="AsyncIO.disconnect" ID="AsyncIO.disconnect"></a> +</p><a NAME="AsyncIO.disconnect" ID="AsyncIO.disconnect"></a> <h4>AsyncIO.disconnect</h4> <b>disconnect</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.DebugClients.Python3.DebugBase.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python3.DebugBase.html Sun Sep 29 18:23:27 2013 +0200 @@ -239,6 +239,11 @@ <dd> type of the exception </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +exception name (string) +</dd> </dl><a NAME="DebugBase.__extract_stack" ID="DebugBase.__extract_stack"></a> <h4>DebugBase.__extract_stack</h4> <b>__extract_stack</b>(<i>exctb</i>) @@ -351,6 +356,11 @@ <dd> local trace function </dd> +</dl><dl> +<dt>Raises <b>bdb.BdbQuit</b>:</dt> +<dd> +raised to indicate the end of the debug session +</dd> </dl><a NAME="DebugBase.dispatch_line" ID="DebugBase.dispatch_line"></a> <h4>DebugBase.dispatch_line</h4> <b>dispatch_line</b>(<i>frame</i>) @@ -370,6 +380,11 @@ <dd> local trace function </dd> +</dl><dl> +<dt>Raises <b>bdb.BdbQuit</b>:</dt> +<dd> +raised to indicate the end of the debug session +</dd> </dl><a NAME="DebugBase.dispatch_return" ID="DebugBase.dispatch_return"></a> <h4>DebugBase.dispatch_return</h4> <b>dispatch_return</b>(<i>frame, arg</i>) @@ -388,6 +403,11 @@ <dd> local trace function </dd> +</dl><dl> +<dt>Raises <b>bdb.BdbQuit</b>:</dt> +<dd> +raised to indicate the end of the debug session +</dd> </dl><a NAME="DebugBase.fix_frame_filename" ID="DebugBase.fix_frame_filename"></a> <h4>DebugBase.fix_frame_filename</h4> <b>fix_frame_filename</b>(<i>frame</i>) @@ -409,6 +429,11 @@ <dd> the frame object </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +fixed up file name (string) +</dd> </dl><a NAME="DebugBase.getCurrentFrame" ID="DebugBase.getCurrentFrame"></a> <h4>DebugBase.getCurrentFrame</h4> <b>getCurrentFrame</b>(<i></i>) @@ -481,6 +506,11 @@ <dd> expression of the watch expression to be cleared (string) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the watch point +</dd> </dl><a NAME="DebugBase.go" ID="DebugBase.go"></a> <h4>DebugBase.go</h4> <b>go</b>(<i>special</i>) @@ -512,13 +542,18 @@ </p><dl> <dt><i>frame</i></dt> <dd> -The current stack frame. +current stack frame. </dd><dt><i>event</i></dt> <dd> -The trace event (string) +trace event (string) </dd><dt><i>arg</i></dt> <dd> -The arguments +arguments +</dd> +</dl><dl> +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +raised to indicate too many recursions </dd> </dl><a NAME="DebugBase.setRecursionDepth" ID="DebugBase.setRecursionDepth"></a> <h4>DebugBase.setRecursionDepth</h4>
--- a/Documentation/Source/eric5.DebugClients.Python3.DebugClientBase.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python3.DebugClientBase.html Sun Sep 29 18:23:27 2013 +0200 @@ -122,7 +122,7 @@ <td>Private method to return the variables of a frame to the debug server.</td> </tr><tr> <td><a href="#DebugClientBase.__exceptionRaised">__exceptionRaised</a></td> -<td>Private method called in the case of an exception</td> +<td>Private method called in the case of an exception.</td> </tr><tr> <td><a href="#DebugClientBase.__formatQt4Variable">__formatQt4Variable</a></td> <td>Private method to produce a formatted output of a simple Qt4/Qt5 type.</td> @@ -297,7 +297,7 @@ <h4>DebugClientBase.__exceptionRaised</h4> <b>__exceptionRaised</b>(<i></i>) <p> - Private method called in the case of an exception + Private method called in the case of an exception. </p><p> It ensures that the debug server is informed of the raised exception. </p><a NAME="DebugClientBase.__formatQt4Variable" ID="DebugClientBase.__formatQt4Variable"></a> @@ -478,11 +478,6 @@ True, if we are attaching to the already started mainthread of the app </dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -The identifier of the created thread -</dd> </dl><a NAME="DebugClientBase.close" ID="DebugClientBase.close"></a> <h4>DebugClientBase.close</h4> <b>close</b>(<i>fd</i>) @@ -535,8 +530,14 @@ <h4>DebugClientBase.fork</h4> <b>fork</b>(<i></i>) <p> - Public method implementing a fork routine deciding which branch to follow. -</p><a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a> + Public method implementing a fork routine deciding which branch + to follow. +</p><dl> +<dt>Returns:</dt> +<dd> +process ID (integer) +</dd> +</dl><a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a> <h4>DebugClientBase.getCoding</h4> <b>getCoding</b>(<i></i>) <p> @@ -551,7 +552,12 @@ <b>getRunning</b>(<i></i>) <p> Public method to return the main script we are currently running. -</p><a NAME="DebugClientBase.handleLine" ID="DebugClientBase.handleLine"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating a running debug session (boolean) +</dd> +</dl><a NAME="DebugClientBase.handleLine" ID="DebugClientBase.handleLine"></a> <h4>DebugClientBase.handleLine</h4> <b>handleLine</b>(<i>line</i>) <p> @@ -731,7 +737,12 @@ <b>DebugClientFork</b>(<i></i>) <p> Replacement for the standard os.fork(). -</p> +</p><dl> +<dt>Returns:</dt> +<dd> +result of the fork() call +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="DebugClientInput" ID="DebugClientInput"></a> @@ -744,7 +755,15 @@ </p><dl> <dt><i>prompt</i></dt> <dd> -The prompt to be shown. (string) +prompt to be shown (string) +</dd><dt><i>echo</i></dt> +<dd> +flag indicating to echo the output (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +result of the input() call </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.DebugClients.Python3.FlexCompleter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python3.FlexCompleter.html Sun Sep 29 18:23:27 2013 +0200 @@ -21,7 +21,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.DebugClients.Python3.FlexCompleter</h1> <p> -Word completion for the eric5 shell +Word completion for the eric5 shell. </p><p> <h4>NOTE for eric5 variant</h4> </p><p> @@ -145,6 +145,12 @@ <dd> The namespace for the completer. </dd> +</dl><dl> +<dt>Raises <b>TypeError</b>:</dt> +<dd> +raised to indicate a wrong data structure of + the namespace object +</dd> </dl><a NAME="Completer._callable_postfix" ID="Completer._callable_postfix"></a> <h4>Completer._callable_postfix</h4> <b>_callable_postfix</b>(<i>val, word</i>)
--- a/Documentation/Source/eric5.DebugClients.Python3.PyProfile.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python3.PyProfile.html Sun Sep 29 18:23:27 2013 +0200 @@ -145,6 +145,11 @@ <dd> the frame object </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +fixed up file name (string) +</dd> </dl><a NAME="PyProfile.save" ID="PyProfile.save"></a> <h4>PyProfile.save</h4> <b>save</b>(<i></i>) @@ -158,7 +163,20 @@ </p><p> This is a variant of the one found in the standard Python profile.py calling fix_frame_filename above. -</p> +</p><dl> +<dt><i>frame</i></dt> +<dd> +reference to the call frame +</dd><dt><i>t</i></dt> +<dd> +arguments +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful handling (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.DebugClients.Python3.eric5dbgstub.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DebugClients.Python3.eric5dbgstub.html Sun Sep 29 18:23:27 2013 +0200 @@ -63,6 +63,11 @@ <dd> flag indicating success (boolean) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate a wrong debugger kind +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr />
--- a/Documentation/Source/eric5.Debugger.BreakPointModel.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Debugger.BreakPointModel.html Sun Sep 29 18:23:27 2013 +0200 @@ -125,9 +125,9 @@ <p> Constructor </p><dl> -<dt><i>reference</i></dt> +<dt><i>parent</i></dt> <dd> -to the parent widget (QObject) +reference to the parent widget (QObject) </dd> </dl><a NAME="BreakPointModel.addBreakPoint" ID="BreakPointModel.addBreakPoint"></a> <h4>BreakPointModel.addBreakPoint</h4> @@ -153,6 +153,11 @@ <p> Public method to get the current column count. </p><dl> +<dt><i>parent</i></dt> +<dd> +reference to parent index (QModelIndex) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> column count (integer) @@ -240,7 +245,7 @@ <dt><i>fn</i></dt> <dd> filename of the breakpoint (string) -</dd><dt><i>line</i></dt> +</dd><dt><i>lineno</i></dt> <dd> line number of the breakpoint (integer) </dd> @@ -342,6 +347,11 @@ <p> Public method to get the current row count. </p><dl> +<dt><i>parent</i></dt> +<dd> +reference to parent index (QModelIndex) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> row count (integer)
--- a/Documentation/Source/eric5.Debugger.BreakPointViewer.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Debugger.BreakPointViewer.html Sun Sep 29 18:23:27 2013 +0200 @@ -274,6 +274,11 @@ <dd> source index to be converted (QModelIndex) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +mapped index (QModelIndex) +</dd> </dl><a NAME="BreakPointViewer.__getSelectedItemsCount" ID="BreakPointViewer.__getSelectedItemsCount"></a> <h4>BreakPointViewer.__getSelectedItemsCount</h4> <b>__getSelectedItemsCount</b>(<i></i>) @@ -355,6 +360,11 @@ <dd> index to be converted (QModelIndex) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +mapped index (QModelIndex) +</dd> </dl><a NAME="BreakPointViewer.handleResetUI" ID="BreakPointViewer.handleResetUI"></a> <h4>BreakPointViewer.handleResetUI</h4> <b>handleResetUI</b>(<i></i>) @@ -379,9 +389,9 @@ <p> Public slot to set the breakpoint model. </p><dl> -<dt><i>reference</i></dt> +<dt><i>model</i></dt> <dd> -to the breakpoint model (BreakPointModel) +reference to the breakpoint model (BreakPointModel) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.Debugger.DebugServer.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Debugger.DebugServer.html Sun Sep 29 18:23:27 2013 +0200 @@ -535,9 +535,12 @@ <p> Private slot to set changed breakpoints. </p><dl> -<dt><i>indexes</i></dt> +<dt><i>startIndex</i></dt> <dd> -indexes of changed breakpoints. +starting index of the change breakpoins (QModelIndex) +</dd><dt><i>endIndex</i></dt> +<dd> +ending index of the change breakpoins (QModelIndex) </dd> </dl><a NAME="DebugServer.__changeWatchPoints" ID="DebugServer.__changeWatchPoints"></a> <h4>DebugServer.__changeWatchPoints</h4> @@ -1653,7 +1656,7 @@ <p> Public method to process the client thread list info. </p><dl> -<dt><i>currentID</i></dt> +<dt><i>currentId</i></dt> <dd> id of the current thread (integer) </dd><dt><i>threadList</i></dt>
--- a/Documentation/Source/eric5.Debugger.DebugViewer.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Debugger.DebugViewer.html Sun Sep 29 18:23:27 2013 +0200 @@ -91,10 +91,10 @@ <td>Private slot to handle the selection of a new stack frame number.</td> </tr><tr> <td><a href="#DebugViewer.__setGlobalsFilter">__setGlobalsFilter</a></td> -<td>Private slot to set the global variable filter</td> +<td>Private slot to set the global variable filter.</td> </tr><tr> <td><a href="#DebugViewer.__setLocalsFilter">__setLocalsFilter</a></td> -<td>Private slot to set the local variable filter</td> +<td>Private slot to set the local variable filter.</td> </tr><tr> <td><a href="#DebugViewer.__showSource">__showSource</a></td> <td>Private slot to handle the source button press to show the selected file.</td> @@ -219,12 +219,12 @@ <h4>DebugViewer.__setGlobalsFilter</h4> <b>__setGlobalsFilter</b>(<i></i>) <p> - Private slot to set the global variable filter + Private slot to set the global variable filter. </p><a NAME="DebugViewer.__setLocalsFilter" ID="DebugViewer.__setLocalsFilter"></a> <h4>DebugViewer.__setLocalsFilter</h4> <b>__setLocalsFilter</b>(<i></i>) <p> - Private slot to set the local variable filter + Private slot to set the local variable filter. </p><a NAME="DebugViewer.__showSource" ID="DebugViewer.__showSource"></a> <h4>DebugViewer.__showSource</h4> <b>__showSource</b>(<i></i>)
--- a/Documentation/Source/eric5.Debugger.DebuggerInterfaceRuby.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Debugger.DebuggerInterfaceRuby.html Sun Sep 29 18:23:27 2013 +0200 @@ -172,7 +172,7 @@ <td>Public method to start a unittest run.</td> </tr><tr> <td><a href="#DebuggerInterfaceRuby.remoteUTStop">remoteUTStop</a></td> -<td>public method to stop a unittest run.</td> +<td>Public method to stop a unittest run.</td> </tr><tr> <td><a href="#DebuggerInterfaceRuby.remoteWatchpoint">remoteWatchpoint</a></td> <td>Public method to set or clear a watch expression.</td> @@ -480,6 +480,12 @@ flag indicating that coverage info should be cleared first (boolean) </dd> +</dl><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this interface + is not supported +</dd> </dl><a NAME="DebuggerInterfaceRuby.remoteEnvironment" ID="DebuggerInterfaceRuby.remoteEnvironment"></a> <h4>DebuggerInterfaceRuby.remoteEnvironment</h4> <b>remoteEnvironment</b>(<i>env</i>) @@ -560,6 +566,12 @@ <dd> flag indicating that timing info should be cleared first (boolean) </dd> +</dl><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this interface + is not supported +</dd> </dl><a NAME="DebuggerInterfaceRuby.remoteRawInput" ID="DebuggerInterfaceRuby.remoteRawInput"></a> <h4>DebuggerInterfaceRuby.remoteRawInput</h4> <b>remoteRawInput</b>(<i>s</i>) @@ -669,17 +681,35 @@ <dd> flag indicating erasure of coverage data is requested (boolean) </dd> +</dl><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this interface + is not supported +</dd> </dl><a NAME="DebuggerInterfaceRuby.remoteUTRun" ID="DebuggerInterfaceRuby.remoteUTRun"></a> <h4>DebuggerInterfaceRuby.remoteUTRun</h4> <b>remoteUTRun</b>(<i></i>) <p> Public method to start a unittest run. -</p><a NAME="DebuggerInterfaceRuby.remoteUTStop" ID="DebuggerInterfaceRuby.remoteUTStop"></a> +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this interface + is not supported +</dd> +</dl><a NAME="DebuggerInterfaceRuby.remoteUTStop" ID="DebuggerInterfaceRuby.remoteUTStop"></a> <h4>DebuggerInterfaceRuby.remoteUTStop</h4> <b>remoteUTStop</b>(<i></i>) <p> - public method to stop a unittest run. -</p><a NAME="DebuggerInterfaceRuby.remoteWatchpoint" ID="DebuggerInterfaceRuby.remoteWatchpoint"></a> + Public method to stop a unittest run. +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this interface + is not supported +</dd> +</dl><a NAME="DebuggerInterfaceRuby.remoteWatchpoint" ID="DebuggerInterfaceRuby.remoteWatchpoint"></a> <h4>DebuggerInterfaceRuby.remoteWatchpoint</h4> <b>remoteWatchpoint</b>(<i>cond, set, temp=False</i>) <p>
--- a/Documentation/Source/eric5.Debugger.EditBreakpointDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Debugger.EditBreakpointDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -96,13 +96,20 @@ the list of conditionals history (list of strings) </dd><dt><i>parent</i></dt> <dd> -the parent of this dialog +the parent of this dialog (QWidget) </dd><dt><i>name</i></dt> <dd> -the widget name of this dialog +the widget name of this dialog (string) </dd><dt><i>modal</i></dt> <dd> -flag indicating a modal dialog +flag indicating a modal dialog (boolean) +</dd><dt><i>addMode</i></dt> +<dd> +flag indicating the add mode (boolean) +</dd><dt><i>filenameHistory</i></dt> +<dd> +list of recently used file names + (list of strings) </dd> </dl><a NAME="EditBreakpointDialog.getAddData" ID="EditBreakpointDialog.getAddData"></a> <h4>EditBreakpointDialog.getAddData</h4>
--- a/Documentation/Source/eric5.Debugger.VariablesViewer.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Debugger.VariablesViewer.html Sun Sep 29 18:23:27 2013 +0200 @@ -109,6 +109,11 @@ <dd> the column to sort on (integer) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +key of the item (string) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> @@ -176,6 +181,11 @@ <dd> the column to sort on (integer) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +key of the item (string) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr />
--- a/Documentation/Source/eric5.Debugger.WatchPointModel.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Debugger.WatchPointModel.html Sun Sep 29 18:23:27 2013 +0200 @@ -119,9 +119,9 @@ <p> Constructor </p><dl> -<dt><i>reference</i></dt> +<dt><i>parent</i></dt> <dd> -to the parent widget (QObject) +reference to the parent widget (QObject) </dd> </dl><a NAME="WatchPointModel.addWatchPoint" ID="WatchPointModel.addWatchPoint"></a> <h4>WatchPointModel.addWatchPoint</h4> @@ -146,6 +146,11 @@ <p> Public method to get the current column count. </p><dl> +<dt><i>parent</i></dt> +<dd> +index of the parent item (QModelIndex) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> column count (integer) @@ -320,6 +325,11 @@ <p> Public method to get the current row count. </p><dl> +<dt><i>parent</i></dt> +<dd> +index of the parent item (QModelIndex) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> row count (integer)
--- a/Documentation/Source/eric5.Debugger.WatchPointViewer.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Debugger.WatchPointViewer.html Sun Sep 29 18:23:27 2013 +0200 @@ -287,6 +287,11 @@ <dd> source index to be converted (QModelIndex) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +mapped index (QModelIndex) +</dd> </dl><a NAME="WatchPointViewer.__getSelectedItemsCount" ID="WatchPointViewer.__getSelectedItemsCount"></a> <h4>WatchPointViewer.__getSelectedItemsCount</h4> <b>__getSelectedItemsCount</b>(<i></i>) @@ -363,15 +368,20 @@ <dd> index to be converted (QModelIndex) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +mapped index (QModelIndex) +</dd> </dl><a NAME="WatchPointViewer.setModel" ID="WatchPointViewer.setModel"></a> <h4>WatchPointViewer.setModel</h4> <b>setModel</b>(<i>model</i>) <p> Public slot to set the watch expression model. </p><dl> -<dt><i>reference</i></dt> +<dt><i>model</i></dt> <dd> -to the watch expression model (WatchPointModel) +reference to the watch expression model (WatchPointModel) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.DocumentationTools.APIGenerator.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DocumentationTools.APIGenerator.html Sun Sep 29 18:23:27 2013 +0200 @@ -105,9 +105,9 @@ <p> Private method to generate class api section for class variables. </p><dl> -<dt><i>classname</i></dt> +<dt><i>className</i></dt> <dd> -Name of the class containing the class variables. (string) +name of the class containing the class variables (string) </dd> </dl><a NAME="APIGenerator.__addClassesAPI" ID="APIGenerator.__addClassesAPI"></a> <h4>APIGenerator.__addClassesAPI</h4> @@ -130,9 +130,9 @@ <p> Private method to generate the api section for class methods. </p><dl> -<dt><i>classname</i></dt> +<dt><i>className</i></dt> <dd> -Name of the class containing the method. (string) +name of the class containing the method (string) </dd> </dl><a NAME="APIGenerator.__isPrivate" ID="APIGenerator.__isPrivate"></a> <h4>APIGenerator.__isPrivate</h4>
--- a/Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html Sun Sep 29 18:23:27 2013 +0200 @@ -180,14 +180,14 @@ Private method to check, if the object to be documented contains a deprecated flag. </p><dl> -<dt><i>desc</i></dt> +<dt><i>descr</i></dt> <dd> -The documentation string. (string) +documentation string (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> -Flag indicating the deprecation status. (boolean) +flag indicating the deprecation status (boolean) </dd> </dl><a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> <h4>ModuleDocument.__formatCrossReferenceEntry</h4> @@ -530,6 +530,11 @@ <dd> processed line with inline tags expanded (string) </dd> +</dl><dl> +<dt>Raises <b>TagError</b>:</dt> +<dd> +raised to indicate an invalid tag +</dd> </dl><a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a> <h4>ModuleDocument.description</h4> <b>description</b>(<i></i>)
--- a/Documentation/Source/eric5.E5Graphics.E5GraphicsView.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Graphics.E5GraphicsView.html Sun Sep 29 18:23:27 2013 +0200 @@ -242,12 +242,12 @@ <p> Public method to resize the scene. </p><dl> -<dt><i>isWidth</i></dt> +<dt><i>amount</i></dt> +<dd> +size increment (integer) +</dd><dt><i>isWidth</i></dt> <dd> flag indicating width is to be resized (boolean) -</dd><dt><i>amount</i></dt> -<dd> -size increment (integer) </dd> </dl><a NAME="E5GraphicsView.saveImage" ID="E5GraphicsView.saveImage"></a> <h4>E5GraphicsView.saveImage</h4>
--- a/Documentation/Source/eric5.E5Gui.E5Action.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5Action.html Sun Sep 29 18:23:27 2013 +0200 @@ -89,7 +89,12 @@ <b>ArgumentsError</b>(<i>error</i>) <p> Constructor -</p><a NAME="ArgumentsError.__repr__" ID="ArgumentsError.__repr__"></a> +</p><dl> +<dt><i>error</i></dt> +<dd> +error message of the exception (string) +</dd> +</dl><a NAME="ArgumentsError.__repr__" ID="ArgumentsError.__repr__"></a> <h4>ArgumentsError.__repr__</h4> <b>__repr__</b>(<i></i>) <p> @@ -180,6 +185,11 @@ parent (QObject), name (string)</li> </ul> </dd> +</dl><dl> +<dt>Raises <b>ArgumentsError</b>:</dt> +<dd> +raised to indicate invalid arguments +</dd> </dl><a NAME="E5Action.__ammendToolTip" ID="E5Action.__ammendToolTip"></a> <h4>E5Action.__ammendToolTip</h4> <b>__ammendToolTip</b>(<i></i>)
--- a/Documentation/Source/eric5.E5Gui.E5ComboBox.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5ComboBox.html Sun Sep 29 18:23:27 2013 +0200 @@ -134,9 +134,12 @@ <b>inactiveText</b>(<i></i>) <p> Public method to get the inactive text. -</p><p> - return inactive text (string) -</p><a NAME="E5ComboBox.setInactiveText" ID="E5ComboBox.setInactiveText"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +inactive text (string) +</dd> +</dl><a NAME="E5ComboBox.setInactiveText" ID="E5ComboBox.setInactiveText"></a> <h4>E5ComboBox.setInactiveText</h4> <b>setInactiveText</b>(<i>inactiveText</i>) <p>
--- a/Documentation/Source/eric5.E5Gui.E5ErrorMessage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5ErrorMessage.html Sun Sep 29 18:23:27 2013 +0200 @@ -175,7 +175,12 @@ <p> Module function to install an E5ErrorMessage dialog as the global message handler. -</p> +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the message handler dialog (E5ErrorMessage) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.E5Gui.E5Led.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5Led.html Sun Sep 29 18:23:27 2013 +0200 @@ -96,7 +96,7 @@ <td>Protected slot handling the paint event.</td> </tr><tr> <td><a href="#E5Led.ratio">ratio</a></td> -<td>Public method to return the LED rectangular ratio (width / height).</td> +<td>Public method to return the LED rectangular ratio [= width / height].</td> </tr><tr> <td><a href="#E5Led.setColor">setColor</a></td> <td>Public method to set the LED color.</td> @@ -145,7 +145,7 @@ </dd><dt><i>shape</i></dt> <dd> shape of the LED (E5LedCircular, E5LedRectangular) -</dd><dt><i>rectRation</i></dt> +</dd><dt><i>rectRatio</i></dt> <dd> ratio width to height, if shape is rectangular (float) </dd> @@ -248,7 +248,7 @@ <h4>E5Led.ratio</h4> <b>ratio</b>(<i></i>) <p> - Public method to return the LED rectangular ratio (width / height). + Public method to return the LED rectangular ratio [= width / height]. </p><dl> <dt>Returns:</dt> <dd>
--- a/Documentation/Source/eric5.E5Gui.E5LineEdit.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5LineEdit.html Sun Sep 29 18:23:27 2013 +0200 @@ -204,9 +204,9 @@ <p> Protected method to handle events. </p><dl> -<dt><i>reference</i></dt> +<dt><i>evt</i></dt> <dd> -to the event (QEvent) +reference to the event (QEvent) </dd> </dl><dl> <dt>Returns:</dt> @@ -218,9 +218,12 @@ <b>inactiveText</b>(<i></i>) <p> Public method to get the inactive text. -</p><p> - return inactive text (string) -</p><a NAME="E5LineEdit.leftMargin" ID="E5LineEdit.leftMargin"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +inactive text (string) +</dd> +</dl><a NAME="E5LineEdit.leftMargin" ID="E5LineEdit.leftMargin"></a> <h4>E5LineEdit.leftMargin</h4> <b>leftMargin</b>(<i></i>) <p> @@ -290,6 +293,11 @@ <dd> side to get margin for (E5LineEdit.LeftSide, E5LineEdit.RightSide) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +text margin (integer) +</dd> </dl><a NAME="E5LineEdit.widgetSpacing" ID="E5LineEdit.widgetSpacing"></a> <h4>E5LineEdit.widgetSpacing</h4> <b>widgetSpacing</b>(<i></i>) @@ -348,9 +356,9 @@ <p> Protected method to handle events. </p><dl> -<dt><i>reference</i></dt> +<dt><i>evt</i></dt> <dd> -to the event (QEvent) +reference to the event (QEvent) </dd> </dl><dl> <dt>Returns:</dt>
--- a/Documentation/Source/eric5.E5Gui.E5ModelMenu.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5ModelMenu.html Sun Sep 29 18:23:27 2013 +0200 @@ -281,9 +281,9 @@ </dd><dt><i>text</i></dt> <dd> text of the action (string) -</dd><dt><i>reference</i></dt> +</dd><dt><i>parent</i></dt> <dd> -to the parent object (QObject) +reference to the parent object (QObject) </dd> </dl><dl> <dt>Returns:</dt>
--- a/Documentation/Source/eric5.E5Gui.E5PasswordMeter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5PasswordMeter.html Sun Sep 29 18:23:27 2013 +0200 @@ -105,21 +105,36 @@ Public method to set the maximum value. </p><p> Overwritten to do nothing. -</p><a NAME="E5PasswordMeter.setMinimum" ID="E5PasswordMeter.setMinimum"></a> +</p><dl> +<dt><i>value</i></dt> +<dd> +maximum value (integer) +</dd> +</dl><a NAME="E5PasswordMeter.setMinimum" ID="E5PasswordMeter.setMinimum"></a> <h4>E5PasswordMeter.setMinimum</h4> <b>setMinimum</b>(<i>value</i>) <p> Public method to set the minimal value. </p><p> Overwritten to do nothing. -</p><a NAME="E5PasswordMeter.setValue" ID="E5PasswordMeter.setValue"></a> +</p><dl> +<dt><i>value</i></dt> +<dd> +minimum value (integer) +</dd> +</dl><a NAME="E5PasswordMeter.setValue" ID="E5PasswordMeter.setValue"></a> <h4>E5PasswordMeter.setValue</h4> <b>setValue</b>(<i>value</i>) <p> Public method to set the value. </p><p> Overwritten to do nothing. -</p> +</p><dl> +<dt><i>value</i></dt> +<dd> +value (integer) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.E5Gui.E5SideBar.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5SideBar.html Sun Sep 29 18:23:27 2013 +0200 @@ -603,9 +603,9 @@ <dt><i>index</i></dt> <dd> index of the tab (integer) -</dd><dt><i>tooltip</i></dt> +</dd><dt><i>tip</i></dt> <dd> -text text to set (string) +tooltip text to set (string) </dd> </dl><a NAME="E5SideBar.setTabWhatsThis" ID="E5SideBar.setTabWhatsThis"></a> <h4>E5SideBar.setTabWhatsThis</h4> @@ -616,9 +616,9 @@ <dt><i>index</i></dt> <dd> index of the tab (integer) -</dd><dt><i>WhatsThis</i></dt> +</dd><dt><i>text</i></dt> <dd> -text text to set (string) +WhatsThis text to set (string) </dd> </dl><a NAME="E5SideBar.shrink" ID="E5SideBar.shrink"></a> <h4>E5SideBar.shrink</h4>
--- a/Documentation/Source/eric5.E5Gui.E5TabWidget.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5TabWidget.html Sun Sep 29 18:23:27 2013 +0200 @@ -404,9 +404,9 @@ <p> Protected slot to support wheel events. </p><dl> -<dt><i>reference</i></dt> +<dt><i>event</i></dt> <dd> -to the wheel event (QWheelEvent) +reference to the wheel event (QWheelEvent) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.E5Gui.E5TextSpinBox.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5TextSpinBox.html Sun Sep 29 18:23:27 2013 +0200 @@ -20,7 +20,9 @@ </head> <body><a NAME="top" ID="top"></a> <h1>eric5.E5Gui.E5TextSpinBox</h1> - +<p> +Module implementing a spinbox with textual entries. +</p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr>
--- a/Documentation/Source/eric5.E5Gui.E5ToolBarDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5ToolBarDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -97,7 +97,7 @@ <td>Private slot to create a new toolbar.</td> </tr><tr> <td><a href="#E5ToolBarDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> -<td>Private slot to remove a custom toolbar</td> +<td>Private slot to remove a custom toolbar.</td> </tr><tr> <td><a href="#E5ToolBarDialog.on_renameButton_clicked">on_renameButton_clicked</a></td> <td>Private slot to rename a custom toolbar.</td> @@ -106,7 +106,7 @@ <td>Private slot to add an action to the list.</td> </tr><tr> <td><a href="#E5ToolBarDialog.on_toolbarActionsList_currentItemChanged">on_toolbarActionsList_currentItemChanged</a></td> -<td>Slot documentation goes here.</td> +<td>Private slot to handle a change of the current item.</td> </tr><tr> <td><a href="#E5ToolBarDialog.on_upButton_clicked">on_upButton_clicked</a></td> <td>Private slot used to move an action up in the list.</td> @@ -154,7 +154,12 @@ <b>__saveToolBars</b>(<i></i>) <p> Private method to save the configured toolbars. -</p><a NAME="E5ToolBarDialog.__setupButtons" ID="E5ToolBarDialog.__setupButtons"></a> +</p><dl> +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +raised to indicate an invalid action +</dd> +</dl><a NAME="E5ToolBarDialog.__setupButtons" ID="E5ToolBarDialog.__setupButtons"></a> <h4>E5ToolBarDialog.__setupButtons</h4> <b>__setupButtons</b>(<i></i>) <p> @@ -174,12 +179,26 @@ <b>on_actionsTree_currentItemChanged</b>(<i>current, previous</i>) <p> Private slot called, when the currently selected action changes. -</p><a NAME="E5ToolBarDialog.on_buttonBox_clicked" ID="E5ToolBarDialog.on_buttonBox_clicked"></a> +</p><dl> +<dt><i>current</i></dt> +<dd> +reference to the current item (QTreeWidgetItem) +</dd><dt><i>previous</i></dt> +<dd> +reference to the previous current item + (QTreeWidgetItem) +</dd> +</dl><a NAME="E5ToolBarDialog.on_buttonBox_clicked" ID="E5ToolBarDialog.on_buttonBox_clicked"></a> <h4>E5ToolBarDialog.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>) <p> Private slot called, when a button of the button box was clicked. -</p><a NAME="E5ToolBarDialog.on_downButton_clicked" ID="E5ToolBarDialog.on_downButton_clicked"></a> +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button clicked (QAbstractButton) +</dd> +</dl><a NAME="E5ToolBarDialog.on_downButton_clicked" ID="E5ToolBarDialog.on_downButton_clicked"></a> <h4>E5ToolBarDialog.on_downButton_clicked</h4> <b>on_downButton_clicked</b>(<i></i>) <p> @@ -198,7 +217,7 @@ <h4>E5ToolBarDialog.on_removeButton_clicked</h4> <b>on_removeButton_clicked</b>(<i></i>) <p> - Private slot to remove a custom toolbar + Private slot to remove a custom toolbar. </p><a NAME="E5ToolBarDialog.on_renameButton_clicked" ID="E5ToolBarDialog.on_renameButton_clicked"></a> <h4>E5ToolBarDialog.on_renameButton_clicked</h4> <b>on_renameButton_clicked</b>(<i></i>) @@ -213,8 +232,17 @@ <h4>E5ToolBarDialog.on_toolbarActionsList_currentItemChanged</h4> <b>on_toolbarActionsList_currentItemChanged</b>(<i>current, previous</i>) <p> - Slot documentation goes here. -</p><a NAME="E5ToolBarDialog.on_upButton_clicked" ID="E5ToolBarDialog.on_upButton_clicked"></a> + Private slot to handle a change of the current item. +</p><dl> +<dt><i>current</i></dt> +<dd> +reference to the current item (QListWidgetItem) +</dd><dt><i>previous</i></dt> +<dd> +reference to the previous current item + (QListWidgetItem) +</dd> +</dl><a NAME="E5ToolBarDialog.on_upButton_clicked" ID="E5ToolBarDialog.on_upButton_clicked"></a> <h4>E5ToolBarDialog.on_upButton_clicked</h4> <b>on_upButton_clicked</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.E5Gui.E5ToolBarManager.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5ToolBarManager.html Sun Sep 29 18:23:27 2013 +0200 @@ -345,6 +345,11 @@ <dd> reference to the toolbar to be checked (QToolBar) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating an added toolbar (boolean) +</dd> </dl><a NAME="E5ToolBarManager.isWidgetAction" ID="E5ToolBarManager.isWidgetAction"></a> <h4>E5ToolBarManager.isWidgetAction</h4> <b>isWidgetAction</b>(<i>action</i>)
--- a/Documentation/Source/eric5.E5Gui.E5TreeWidget.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5TreeWidget.html Sun Sep 29 18:23:27 2013 +0200 @@ -195,6 +195,12 @@ <dd> flag indicating success (boolean) </dd> +</dl><dl> +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +raised to indicate an illegal type for + the parent +</dd> </dl><a NAME="E5TreeWidget.clear" ID="E5TreeWidget.clear"></a> <h4>E5TreeWidget.clear</h4> <b>clear</b>(<i></i>) @@ -285,6 +291,12 @@ <dd> flag indicating success (boolean) </dd> +</dl><dl> +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +raised to indicate an illegal type for + the parent +</dd> </dl><a NAME="E5TreeWidget.setDefaultItemShowMode" ID="E5TreeWidget.setDefaultItemShowMode"></a> <h4>E5TreeWidget.setDefaultItemShowMode</h4> <b>setDefaultItemShowMode</b>(<i>mode</i>)
--- a/Documentation/Source/eric5.E5Gui.E5ZoomWidget.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Gui.E5ZoomWidget.html Sun Sep 29 18:23:27 2013 +0200 @@ -267,7 +267,12 @@ <b>on_slider_sliderMoved</b>(<i>value</i>) <p> Public slot to handle changes of the zoom value. -</p><a NAME="E5ZoomWidget.pageStep" ID="E5ZoomWidget.pageStep"></a> +</p><dl> +<dt><i>value</i></dt> +<dd> +value of the slider (integer) +</dd> +</dl><a NAME="E5ZoomWidget.pageStep" ID="E5ZoomWidget.pageStep"></a> <h4>E5ZoomWidget.pageStep</h4> <b>pageStep</b>(<i></i>) <p> @@ -314,7 +319,7 @@ <p> Public method to set the maximum value. </p><dl> -<dt><i>minimum</i></dt> +<dt><i>maximum</i></dt> <dd> new maximum value (integer) </dd>
--- a/Documentation/Source/eric5.E5Network.E5NetworkMonitor.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5Network.E5NetworkMonitor.html Sun Sep 29 18:23:27 2013 +0200 @@ -105,6 +105,11 @@ reference to the network access manager (QNetworkAccessManager) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the network monitor singleton (E5NetworkMonitor) +</dd> </dl><a NAME="E5NetworkMonitor.__init__" ID="E5NetworkMonitor.__init__"></a> <h4>E5NetworkMonitor (Constructor)</h4> <b>E5NetworkMonitor</b>(<i>networkAccessManager, parent=None</i>)
--- a/Documentation/Source/eric5.E5XML.XMLStreamReaderBase.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.E5XML.XMLStreamReaderBase.html Sun Sep 29 18:23:27 2013 +0200 @@ -195,6 +195,11 @@ <dd> default value (string) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +value of the requested tag attribute (string) +</dd> </dl><a NAME="XMLStreamReaderBase.raiseBadValue" ID="XMLStreamReaderBase.raiseBadValue"></a> <h4>XMLStreamReaderBase.raiseBadValue</h4> <b>raiseBadValue</b>(<i>value</i>)
--- a/Documentation/Source/eric5.Graphics.ApplicationDiagramBuilder.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Graphics.ApplicationDiagramBuilder.html Sun Sep 29 18:23:27 2013 +0200 @@ -123,6 +123,11 @@ <dd> y-coordinate (float) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the package item (PackageItem) +</dd> </dl><a NAME="ApplicationDiagramBuilder.__buildModulesDict" ID="ApplicationDiagramBuilder.__buildModulesDict"></a> <h4>ApplicationDiagramBuilder.__buildModulesDict</h4> <b>__buildModulesDict</b>(<i></i>)
--- a/Documentation/Source/eric5.Graphics.AssociationItem.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Graphics.AssociationItem.html Sun Sep 29 18:23:27 2013 +0200 @@ -189,8 +189,8 @@ (lets call it region M). After that the start point will be the middle point of rectangle's side contained in region M. </p><p> - To calculate the end point we repeat the above but in the opposite direction - (from itemB to itemA) + To calculate the end point we repeat the above but in the opposite + direction (from itemB to itemA) </p><a NAME="AssociationItem.__calculateEndingPoints_topToBottom" ID="AssociationItem.__calculateEndingPoints_topToBottom"></a> <h4>AssociationItem.__calculateEndingPoints_topToBottom</h4> <b>__calculateEndingPoints_topToBottom</b>(<i></i>)
--- a/Documentation/Source/eric5.Graphics.ImportsDiagramBuilder.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Graphics.ImportsDiagramBuilder.html Sun Sep 29 18:23:27 2013 +0200 @@ -133,6 +133,11 @@ <dd> y-coordinate (float) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the imports item (ModuleItem) +</dd> </dl><a NAME="ImportsDiagramBuilder.__buildModulesDict" ID="ImportsDiagramBuilder.__buildModulesDict"></a> <h4>ImportsDiagramBuilder.__buildModulesDict</h4> <b>__buildModulesDict</b>(<i></i>)
--- a/Documentation/Source/eric5.Graphics.PackageDiagramBuilder.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Graphics.PackageDiagramBuilder.html Sun Sep 29 18:23:27 2013 +0200 @@ -191,7 +191,19 @@ Private method to arrange the shapes on the canvas. </p><p> The algorithm is borrowed from Boa Constructor. -</p><a NAME="PackageDiagramBuilder.__buildModulesDict" ID="PackageDiagramBuilder.__buildModulesDict"></a> +</p><dl> +<dt><i>nodes</i></dt> +<dd> +list of nodes to arrange +</dd><dt><i>routes</i></dt> +<dd> +list of routes +</dd><dt><i>whiteSpaceFactor</i></dt> +<dd> +factor to increase whitespace between + items (float) +</dd> +</dl><a NAME="PackageDiagramBuilder.__buildModulesDict" ID="PackageDiagramBuilder.__buildModulesDict"></a> <h4>PackageDiagramBuilder.__buildModulesDict</h4> <b>__buildModulesDict</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Graphics.UMLClassDiagramBuilder.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Graphics.UMLClassDiagramBuilder.html Sun Sep 29 18:23:27 2013 +0200 @@ -162,7 +162,19 @@ Private method to arrange the shapes on the canvas. </p><p> The algorithm is borrowed from Boa Constructor. -</p><a NAME="UMLClassDiagramBuilder.__createAssociations" ID="UMLClassDiagramBuilder.__createAssociations"></a> +</p><dl> +<dt><i>nodes</i></dt> +<dd> +list of nodes to arrange +</dd><dt><i>routes</i></dt> +<dd> +list of routes +</dd><dt><i>whiteSpaceFactor</i></dt> +<dd> +factor to increase whitespace between + items (float) +</dd> +</dl><a NAME="UMLClassDiagramBuilder.__createAssociations" ID="UMLClassDiagramBuilder.__createAssociations"></a> <h4>UMLClassDiagramBuilder.__createAssociations</h4> <b>__createAssociations</b>(<i>routes</i>) <p>
--- a/Documentation/Source/eric5.Graphics.UMLDiagramBuilder.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Graphics.UMLDiagramBuilder.html Sun Sep 29 18:23:27 2013 +0200 @@ -100,7 +100,13 @@ Public method to build the diagram. </p><p> This class must be implemented in subclasses. -</p><a NAME="UMLDiagramBuilder.getPersistenceData" ID="UMLDiagramBuilder.getPersistenceData"></a> +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this class + must be subclassed +</dd> +</dl><a NAME="UMLDiagramBuilder.getPersistenceData" ID="UMLDiagramBuilder.getPersistenceData"></a> <h4>UMLDiagramBuilder.getPersistenceData</h4> <b>getPersistenceData</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Graphics.UMLDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Graphics.UMLDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -103,8 +103,8 @@ </p><dl> <dt><i>diagramType</i></dt> <dd> -type of the diagram (one of ApplicationDiagram, ClassDiagram, - ImportsDiagram, NoDiagram, PackageDiagram) +type of the diagram (one of ApplicationDiagram, + ClassDiagram, ImportsDiagram, NoDiagram, PackageDiagram) </dd><dt><i>project</i></dt> <dd> reference to the project object (Project) @@ -116,8 +116,9 @@ parent widget of the dialog (QWidget) </dd><dt><i>initBuilder=</i></dt> <dd> -flag indicating to initialize the diagram builder (boolean) -</dd><dt><i>kwargs</i></dt> +flag indicating to initialize the diagram + builder (boolean) +</dd><dt><i>kwargs=</i></dt> <dd> diagram specific data </dd> @@ -134,10 +135,20 @@ </dd><dt><i>path</i></dt> <dd> file or directory path to build the diagram from (string) -</dd><dt><i>kwargs</i></dt> +</dd><dt><i>kwargs=</i></dt> <dd> diagram specific data </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated diagram builder +</dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an illegal diagram type +</dd> </dl><a NAME="UMLDialog.__diagramTypeString" ID="UMLDialog.__diagramTypeString"></a> <h4>UMLDialog.__diagramTypeString</h4> <b>__diagramTypeString</b>(<i></i>)
--- a/Documentation/Source/eric5.Graphics.UMLGraphicsView.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Graphics.UMLGraphicsView.html Sun Sep 29 18:23:27 2013 +0200 @@ -246,7 +246,12 @@ <b>__printPreviewPrint</b>(<i>printer</i>) <p> Private slot to generate a print preview. -</p><a NAME="UMLGraphicsView.__relayout" ID="UMLGraphicsView.__relayout"></a> +</p><dl> +<dt><i>printer</i></dt> +<dd> +reference to the printer object (QPrinter) +</dd> +</dl><a NAME="UMLGraphicsView.__relayout" ID="UMLGraphicsView.__relayout"></a> <h4>UMLGraphicsView.__relayout</h4> <b>__relayout</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -88,7 +88,7 @@ <td>Private slot to set the enabled state of a subscription.</td> </tr><tr> <td><a href="#AdBlockDialog.__switchSubscriptionEnabled">__switchSubscriptionEnabled</a></td> -<td>Private slot to switch the enabled state of the selected subscription</td> +<td>Private slot to switch the enabled state of the selected subscription.</td> </tr><tr> <td><a href="#AdBlockDialog.__updateAllSubscriptions">__updateAllSubscriptions</a></td> <td>Private slot to update all subscriptions.</td> @@ -127,7 +127,12 @@ <b>AdBlockDialog</b>(<i>parent=None</i>) <p> Constructor -</p><a NAME="AdBlockDialog.__aboutToShowActionMenu" ID="AdBlockDialog.__aboutToShowActionMenu"></a> +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent object (QWidget) +</dd> +</dl><a NAME="AdBlockDialog.__aboutToShowActionMenu" ID="AdBlockDialog.__aboutToShowActionMenu"></a> <h4>AdBlockDialog.__aboutToShowActionMenu</h4> <b>__aboutToShowActionMenu</b>(<i></i>) <p> @@ -184,7 +189,7 @@ <h4>AdBlockDialog.__switchSubscriptionEnabled</h4> <b>__switchSubscriptionEnabled</b>(<i></i>) <p> - Private slot to switch the enabled state of the selected subscription + Private slot to switch the enabled state of the selected subscription. </p><a NAME="AdBlockDialog.__updateAllSubscriptions" ID="AdBlockDialog.__updateAllSubscriptions"></a> <h4>AdBlockDialog.__updateAllSubscriptions</h4> <b>__updateAllSubscriptions</b>(<i></i>)
--- a/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockNetwork.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockNetwork.html Sun Sep 29 18:23:27 2013 +0200 @@ -92,6 +92,11 @@ <p> Public method to check for a network block. </p><dl> +<dt><i>request</i></dt> +<dd> +reference to the request object (QNetworkRequest) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> reply object (QNetworkReply) or None
--- a/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockRule.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockRule.html Sun Sep 29 18:23:27 2013 +0200 @@ -151,7 +151,16 @@ <b>AdBlockRule</b>(<i>filter="", subscription=None</i>) <p> Constructor -</p><a NAME="AdBlockRule.__convertPatternToRegExp" ID="AdBlockRule.__convertPatternToRegExp"></a> +</p><dl> +<dt><i>filter</i></dt> +<dd> +filter string of the rule (string) +</dd><dt><i>subscription</i></dt> +<dd> +reference to the subscription object + (AdBlockSubscription) +</dd> +</dl><a NAME="AdBlockRule.__convertPatternToRegExp" ID="AdBlockRule.__convertPatternToRegExp"></a> <h4>AdBlockRule.__convertPatternToRegExp</h4> <b>__convertPatternToRegExp</b>(<i>wildcardPattern</i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockTreeWidget.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockTreeWidget.html Sun Sep 29 18:23:27 2013 +0200 @@ -107,7 +107,7 @@ <dt><i>subscription</i></dt> <dd> reference to the subscription (AdBlockSubscription) -</dd><dt><i>parenbt</i></dt> +</dd><dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd>
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarkPropertiesDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarkPropertiesDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -74,7 +74,10 @@ <p> Constructor </p><dl> -<dt><i>parent</i></dt> +<dt><i>node</i></dt> +<dd> +reference to the bookmark (BookmarkNode) +</dd><dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd>
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.BookmarksImporter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.BookmarksImporter.html Sun Sep 29 18:23:27 2013 +0200 @@ -118,20 +118,26 @@ <b>importedBookmarks</b>(<i></i>) <p> Public method to get the imported bookmarks. +</p><p> + It must return the imported bookmarks (BookmarkNode). </p><dl> -<dt>Returns:</dt> +<dt>Raises <b>NotImplementedError</b>:</dt> <dd> -imported bookmarks (BookmarkNode) +raised to indicate this method must + be implemented by a subclass </dd> </dl><a NAME="BookmarksImporter.open" ID="BookmarksImporter.open"></a> <h4>BookmarksImporter.open</h4> <b>open</b>(<i></i>) <p> Public method to open the bookmarks file. +</p><p> + It must return a flag indicating success (boolean). </p><dl> -<dt>Returns:</dt> +<dt>Raises <b>NotImplementedError</b>:</dt> <dd> -flag indicating success (boolean) +raised to indicate this method must + be implemented by a subclass </dd> </dl><a NAME="BookmarksImporter.setPath" ID="BookmarksImporter.setPath"></a> <h4>BookmarksImporter.setPath</h4> @@ -143,6 +149,12 @@ <dd> bookmarks file or directory (string) </dd> +</dl><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate this method must + be implemented by a subclass +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.ChromeImporter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.ChromeImporter.html Sun Sep 29 18:23:27 2013 +0200 @@ -177,12 +177,22 @@ <p> Module function to get information for the given source id. </p><dl> +<dt><i>id</i></dt> +<dd> +id of the browser ("chrome" or "chromium") +</dd> +</dl><dl> <dt>Returns:</dt> <dd> tuple with an icon (QPixmap), readable name (string), name of the default bookmarks file (string), an info text (string), a prompt (string) and the default directory of the bookmarks file (string) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid browser ID +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.FirefoxImporter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.FirefoxImporter.html Sun Sep 29 18:23:27 2013 +0200 @@ -129,12 +129,22 @@ <p> Module function to get information for the given source id. </p><dl> +<dt><i>id</i></dt> +<dd> +id of the browser ("chrome" or "chromium") +</dd> +</dl><dl> <dt>Returns:</dt> <dd> tuple with an icon (QPixmap), readable name (string), name of the default bookmarks file (string), an info text (string), a prompt (string) and the default directory of the bookmarks file (string) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid browser ID +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.HtmlImporter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.HtmlImporter.html Sun Sep 29 18:23:27 2013 +0200 @@ -129,12 +129,22 @@ <p> Module function to get information for the given HTML source id. </p><dl> +<dt><i>id</i></dt> +<dd> +id of the browser ("chrome" or "chromium") +</dd> +</dl><dl> <dt>Returns:</dt> <dd> tuple with an icon (QPixmap), readable name (string), name of the default bookmarks file (string), an info text (string), a prompt (string) and the default directory of the bookmarks file (string) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid browser ID +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.IExplorerImporter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.IExplorerImporter.html Sun Sep 29 18:23:27 2013 +0200 @@ -129,12 +129,22 @@ <p> Module function to get information for the given source id. </p><dl> +<dt><i>id</i></dt> +<dd> +id of the browser ("chrome" or "chromium") +</dd> +</dl><dl> <dt>Returns:</dt> <dd> tuple with an icon (QPixmap), readable name (string), name of the default bookmarks file (string), an info text (string), a prompt (string) and the default directory of the bookmarks file (string) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid browser ID +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.OperaImporter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.OperaImporter.html Sun Sep 29 18:23:27 2013 +0200 @@ -129,12 +129,22 @@ <p> Module function to get information for the given source id. </p><dl> +<dt><i>id</i></dt> +<dd> +id of the browser ("chrome" or "chromium") +</dd> +</dl><dl> <dt>Returns:</dt> <dd> tuple with an icon (QPixmap), readable name (string), name of the default bookmarks file (string), an info text (string), a prompt (string) and the default directory of the bookmarks file (string) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid browser ID +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.SafariImporter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.SafariImporter.html Sun Sep 29 18:23:27 2013 +0200 @@ -145,12 +145,22 @@ <p> Module function to get information for the given source id. </p><dl> +<dt><i>id</i></dt> +<dd> +id of the browser ("chrome" or "chromium") +</dd> +</dl><dl> <dt>Returns:</dt> <dd> tuple with an icon (QPixmap), readable name (string), name of the default bookmarks file (string), an info text (string), a prompt (string) and the default directory of the bookmarks file (string) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid browser ID +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.XbelImporter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.XbelImporter.html Sun Sep 29 18:23:27 2013 +0200 @@ -129,12 +129,22 @@ <p> Module function to get information for the given XBEL source id. </p><dl> +<dt><i>id</i></dt> +<dd> +id of the browser ("chrome" or "chromium") +</dd> +</dl><dl> <dt>Returns:</dt> <dd> tuple with an icon (QPixmap), readable name (string), name of the default bookmarks file (string), an info text (string), a prompt (string) and the default directory of the bookmarks file (string) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid browser ID +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.__init__.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.__init__.html Sun Sep 29 18:23:27 2013 +0200 @@ -63,6 +63,11 @@ <dd> bookmarks importer (BookmarksImporter) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an unsupported importer +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> @@ -81,7 +86,13 @@ <dd> tuple with an icon (QPixmap), readable name (string), name of the default bookmarks file (string), an info text (string), - a prompt (string) and the default directory of the bookmarks file (string) + a prompt (string) and the default directory of the bookmarks + file (string) +</dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an unsupported importer </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksManager.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksManager.html Sun Sep 29 18:23:27 2013 +0200 @@ -346,7 +346,13 @@ <b>load</b>(<i></i>) <p> Public method to load the bookmarks. -</p><a NAME="BookmarksManager.menu" ID="BookmarksManager.menu"></a> +</p><dl> +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +raised to indicate an error loading the + bookmarks +</dd> +</dl><a NAME="BookmarksManager.menu" ID="BookmarksManager.menu"></a> <h4>BookmarksManager.menu</h4> <b>menu</b>(<i></i>) <p> @@ -380,8 +386,14 @@ <h4>BookmarksManager.setNodeChanged</h4> <b>setNodeChanged</b>(<i>node</i>) <p> - Public method to signal changes of bookmarks other than title, URL or timestamp. -</p><a NAME="BookmarksManager.setTimestamp" ID="BookmarksManager.setTimestamp"></a> + Public method to signal changes of bookmarks other than title, URL + or timestamp. +</p><dl> +<dt><i>node</i></dt> +<dd> +reference to the bookmark (BookmarkNode) +</dd> +</dl><a NAME="BookmarksManager.setTimestamp" ID="BookmarksManager.setTimestamp"></a> <h4>BookmarksManager.setTimestamp</h4> <b>setTimestamp</b>(<i>node, timestampType, timestamp</i>) <p> @@ -392,8 +404,9 @@ reference to the node to be changed (BookmarkNode) </dd><dt><i>timestampType</i></dt> <dd> -type of the timestamp to set (BookmarkNode.TsAdded, - BookmarkNode.TsModified, BookmarkNode.TsVisited) +type of the timestamp to set + (BookmarkNode.TsAdded, BookmarkNode.TsModified, + BookmarkNode.TsVisited) </dd><dt><i>timestamp</i></dt> <dd> timestamp to set (QDateTime)
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksModel.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksModel.html Sun Sep 29 18:23:27 2013 +0200 @@ -398,9 +398,9 @@ </dd><dt><i>count</i></dt> <dd> number of bookmarks to remove (integer) -</dd><dt><i>index</i></dt> +</dd><dt><i>parent</i></dt> <dd> -of the parent bookmark node (QModelIndex) +index of the parent bookmark node (QModelIndex) </dd> </dl><dl> <dt>Returns:</dt>
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.NsHtmlWriter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.NsHtmlWriter.html Sun Sep 29 18:23:27 2013 +0200 @@ -98,6 +98,11 @@ <dd> root node of the bookmark tree (BookmarkNode) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> </dl><a NAME="NsHtmlWriter.__writeBookmark" ID="NsHtmlWriter.__writeBookmark"></a> <h4>NsHtmlWriter.__writeBookmark</h4> <b>__writeBookmark</b>(<i>node, indent</i>) @@ -161,6 +166,11 @@ <dd> root node of the bookmark tree (BookmarkNode) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.XbelWriter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.XbelWriter.html Sun Sep 29 18:23:27 2013 +0200 @@ -89,6 +89,11 @@ <dd> root node of the bookmark tree (BookmarkNode) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> </dl><a NAME="XbelWriter.__writeItem" ID="XbelWriter.__writeItem"></a> <h4>XbelWriter.__writeItem</h4> <b>__writeItem</b>(<i>node</i>) @@ -113,6 +118,11 @@ <dd> root node of the bookmark tree (BookmarkNode) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.ClosedTabsManager.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.ClosedTabsManager.html Sun Sep 29 18:23:27 2013 +0200 @@ -97,6 +97,11 @@ <dd> reference to the object to compare against (ClosedTab) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating equality of the tabs (boolean) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr />
--- a/Documentation/Source/eric5.Helpviewer.CookieJar.CookieJar.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.CookieJar.CookieJar.html Sun Sep 29 18:23:27 2013 +0200 @@ -73,7 +73,7 @@ <td>Private method to check, if either the rule matches the domain exactly or the domain ends with ".rule".</td> </tr><tr> <td><a href="#CookieJar.__purgeOldCookies">__purgeOldCookies</a></td> -<td>Private method to purge old cookies</td> +<td>Private method to purge old cookies.</td> </tr><tr> <td><a href="#CookieJar.acceptPolicy">acceptPolicy</a></td> <td>Public method to get the accept policy.</td> @@ -184,7 +184,7 @@ <h4>CookieJar.__purgeOldCookies</h4> <b>__purgeOldCookies</b>(<i></i>) <p> - Private method to purge old cookies + Private method to purge old cookies. </p><a NAME="CookieJar.acceptPolicy" ID="CookieJar.acceptPolicy"></a> <h4>CookieJar.acceptPolicy</h4> <b>acceptPolicy</b>(<i></i>) @@ -275,7 +275,12 @@ <b>keepPolicy</b>(<i></i>) <p> Private method to get the keep policy. -</p><a NAME="CookieJar.load" ID="CookieJar.load"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +keep policy +</dd> +</dl><a NAME="CookieJar.load" ID="CookieJar.load"></a> <h4>CookieJar.load</h4> <b>load</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.CookieJar.CookiesConfigurationDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.CookieJar.CookiesConfigurationDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -79,7 +79,12 @@ <b>CookiesConfigurationDialog</b>(<i>parent</i>) <p> Constructor -</p><a NAME="CookiesConfigurationDialog.accept" ID="CookiesConfigurationDialog.accept"></a> +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent object (QWidget) +</dd> +</dl><a NAME="CookiesConfigurationDialog.accept" ID="CookiesConfigurationDialog.accept"></a> <h4>CookiesConfigurationDialog.accept</h4> <b>accept</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.Download.DownloadAskActionDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Download.DownloadAskActionDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -74,7 +74,16 @@ <p> Constructor </p><dl> -<dt><i>parent</i></dt> +<dt><i>fileName</i></dt> +<dd> +file name (string) +</dd><dt><i>mimeType</i></dt> +<dd> +mime type (string) +</dd><dt><i>baseUrl</i></dt> +<dd> +URL (string) +</dd><dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd>
--- a/Documentation/Source/eric5.Helpviewer.Download.DownloadItem.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Download.DownloadItem.html Sun Sep 29 18:23:27 2013 +0200 @@ -79,7 +79,7 @@ <td>Private slot to handle the download finished.</td> </tr><tr> <td><a href="#DownloadItem.__getFileName">__getFileName</a></td> -<td>Private method to get the filename to save to from the user.</td> +<td>Private method to get the file name to save to from the user.</td> </tr><tr> <td><a href="#DownloadItem.__initialize">__initialize</a></td> <td>Private method to (re)initialize the widget.</td> @@ -224,13 +224,8 @@ <h4>DownloadItem.__getFileName</h4> <b>__getFileName</b>(<i></i>) <p> - Private method to get the filename to save to from the user. -</p><dl> -<dt>Returns:</dt> -<dd> -flag indicating success (boolean) -</dd> -</dl><a NAME="DownloadItem.__initialize" ID="DownloadItem.__initialize"></a> + Private method to get the file name to save to from the user. +</p><a NAME="DownloadItem.__initialize" ID="DownloadItem.__initialize"></a> <h4>DownloadItem.__initialize</h4> <b>__initialize</b>(<i>tryAgain=False</i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.Download.DownloadManager.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Download.DownloadManager.html Sun Sep 29 18:23:27 2013 +0200 @@ -31,7 +31,7 @@ <table> <tr> <td><a href="#DownloadManager">DownloadManager</a></td> -<td>Class implementing the download manager</td> +<td>Class implementing the download manager.</td> </tr> </table> <h3>Functions</h3> @@ -42,7 +42,7 @@ <a NAME="DownloadManager" ID="DownloadManager"></a> <h2>DownloadManager</h2> <p> - Class implementing the download manager + Class implementing the download manager. </p> <h3>Derived from</h3> QDialog, Ui_DownloadManager @@ -356,7 +356,7 @@ <dt><i>reply</i></dt> <dd> reference to the reply object (QNetworkReply) -</dd><dt><i>requestFilename=</i></dt> +</dd><dt><i>requestFileName=</i></dt> <dd> indicating to ask for a filename (boolean)
--- a/Documentation/Source/eric5.Helpviewer.Download.DownloadModel.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Download.DownloadModel.html Sun Sep 29 18:23:27 2013 +0200 @@ -153,9 +153,9 @@ </dd><dt><i>count</i></dt> <dd> number of bookmarks to remove (integer) -</dd><dt><i>index</i></dt> +</dd><dt><i>parent</i></dt> <dd> -of the parent bookmark node (QModelIndex) +index of the parent bookmark node (QModelIndex) </dd> </dl><dl> <dt>Returns:</dt>
--- a/Documentation/Source/eric5.Helpviewer.Download.DownloadUtilities.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Download.DownloadUtilities.html Sun Sep 29 18:23:27 2013 +0200 @@ -20,7 +20,9 @@ </head> <body><a NAME="top" ID="top"></a> <h1>eric5.Helpviewer.Download.DownloadUtilities</h1> - +<p> +Module implementing some utility functions for the Download package. +</p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr>
--- a/Documentation/Source/eric5.Helpviewer.Feeds.FeedEditDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Feeds.FeedEditDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -83,7 +83,13 @@ <p> Constructor </p><dl> -<dt><i>parent</i></dt> +<dt><i>urlString</i></dt> +<dd> +feed URL (string) +</dd><dt><i>title</i></dt> +<dd> +feed title (string) +</dd><dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> @@ -115,7 +121,7 @@ </dd> </dl><a NAME="FeedEditDialog.on_urlEdit_textChanged" ID="FeedEditDialog.on_urlEdit_textChanged"></a> <h4>FeedEditDialog.on_urlEdit_textChanged</h4> -<b>on_urlEdit_textChanged</b>(<i>p0</i>) +<b>on_urlEdit_textChanged</b>(<i>txt</i>) <p> Private slot to handle changes of the feed URL. </p><dl>
--- a/Documentation/Source/eric5.Helpviewer.GreaseMonkey.GreaseMonkeyConfiguration.GreaseMonkeyConfigurationDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.GreaseMonkey.GreaseMonkeyConfiguration.GreaseMonkeyConfigurationDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -92,7 +92,10 @@ <p> Constructor </p><dl> -<dt><i>parent</i></dt> +<dt><i>manager</i></dt> +<dd> +reference to the manager object (GreaseMonkeyManager) +</dd><dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> @@ -141,7 +144,12 @@ <b>on_downloadLabel_linkActivated</b>(<i>link</i>) <p> Private slot to open the userscript.org web site. -</p><a NAME="GreaseMonkeyConfigurationDialog.on_openDirectoryButton_clicked" ID="GreaseMonkeyConfigurationDialog.on_openDirectoryButton_clicked"></a> +</p><dl> +<dt><i>link</i></dt> +<dd> +URL (string) +</dd> +</dl><a NAME="GreaseMonkeyConfigurationDialog.on_openDirectoryButton_clicked" ID="GreaseMonkeyConfigurationDialog.on_openDirectoryButton_clicked"></a> <h4>GreaseMonkeyConfigurationDialog.on_openDirectoryButton_clicked</h4> <b>on_openDirectoryButton_clicked</b>(<i></i>) <p> @@ -151,7 +159,12 @@ <b>on_scriptsList_itemDoubleClicked</b>(<i>item</i>) <p> Private slot to show information about the selected script. -</p> +</p><dl> +<dt><i>item</i></dt> +<dd> +reference to the double clicked item (QListWidgetItem) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.Helpviewer.GreaseMonkey.GreaseMonkeyScript.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.GreaseMonkey.GreaseMonkeyScript.html Sun Sep 29 18:23:27 2013 +0200 @@ -222,6 +222,11 @@ <p> Public method to check, if the script matches the given URL. </p><dl> +<dt><i>urlString</i></dt> +<dd> +URL (string) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> flag indicating a match (boolean)
--- a/Documentation/Source/eric5.Helpviewer.GreaseMonkey.GreaseMonkeyUrlMatcher.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.GreaseMonkey.GreaseMonkeyUrlMatcher.html Sun Sep 29 18:23:27 2013 +0200 @@ -107,6 +107,11 @@ <dd> URL to match (string) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful match (boolean) +</dd> </dl><a NAME="GreaseMonkeyUrlMatcher.pattern" ID="GreaseMonkeyUrlMatcher.pattern"></a> <h4>GreaseMonkeyUrlMatcher.pattern</h4> <b>pattern</b>(<i></i>) @@ -133,6 +138,11 @@ <dd> pattern to be used (string) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful match (boolean) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.HelpBrowserWV.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.HelpBrowserWV.html Sun Sep 29 18:23:27 2013 +0200 @@ -792,6 +792,11 @@ <dd> type of the requested window (QWebPage.WebWindowType) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the created browser window (HelpBrowser) +</dd> </dl><a NAME="HelpBrowser.documentTitle" ID="HelpBrowser.documentTitle"></a> <h4>HelpBrowser.documentTitle</h4> <b>documentTitle</b>(<i></i>) @@ -1029,7 +1034,12 @@ <b>progress</b>(<i></i>) <p> Public method to get the load progress. -</p><a NAME="HelpBrowser.reload" ID="HelpBrowser.reload"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +load progress (integer) +</dd> +</dl><a NAME="HelpBrowser.reload" ID="HelpBrowser.reload"></a> <h4>HelpBrowser.reload</h4> <b>reload</b>(<i></i>) <p> @@ -1389,7 +1399,12 @@ <b>showSslInfo</b>(<i>pos</i>) <p> Public slot to show some SSL information for the loaded page. -</p><a NAME="HelpWebPage.supportsExtension" ID="HelpWebPage.supportsExtension"></a> +</p><dl> +<dt><i>pos</i></dt> +<dd> +position to show the info at (QPoint) +</dd> +</dl><a NAME="HelpWebPage.supportsExtension" ID="HelpWebPage.supportsExtension"></a> <h4>HelpWebPage.supportsExtension</h4> <b>supportsExtension</b>(<i>extension</i>) <p> @@ -1634,6 +1649,11 @@ <p> Module function to do some content sniffing to check, if the data is HTML. </p><dl> +<dt><i>data</i></dt> +<dd> +data block to sniff at (string) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> flag indicating HTML content (boolean)
--- a/Documentation/Source/eric5.Helpviewer.HelpTabBar.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.HelpTabBar.html Sun Sep 29 18:23:27 2013 +0200 @@ -132,9 +132,9 @@ <p> Protected method to handle mouse move events. </p><dl> -<dt><i>reference</i></dt> +<dt><i>evt</i></dt> <dd> -to the mouse move event (QMouseEvent) +reference to the mouse move event (QMouseEvent) </dd> </dl><a NAME="HelpTabBar.mousePressEvent" ID="HelpTabBar.mousePressEvent"></a> <h4>HelpTabBar.mousePressEvent</h4>
--- a/Documentation/Source/eric5.Helpviewer.HelpWebSearchWidget.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.HelpWebSearchWidget.html Sun Sep 29 18:23:27 2013 +0200 @@ -168,6 +168,11 @@ <dd> index of the item (QModelIndex) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flah indicating a successful highlighting (boolean) +</dd> </dl><a NAME="HelpWebSearchWidget.__currentEngineChanged" ID="HelpWebSearchWidget.__currentEngineChanged"></a> <h4>HelpWebSearchWidget.__currentEngineChanged</h4> <b>__currentEngineChanged</b>(<i></i>)
--- a/Documentation/Source/eric5.Helpviewer.History.HistoryCompleter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.History.HistoryCompleter.html Sun Sep 29 18:23:27 2013 +0200 @@ -31,7 +31,7 @@ <table> <tr> <td><a href="#HistoryCompleter">HistoryCompleter</a></td> -<td></td> +<td>Class implementing a completer for the browser history.</td> </tr><tr> <td><a href="#HistoryCompletionModel">HistoryCompletionModel</a></td> <td>Class implementing a special model for history based completions.</td> @@ -47,7 +47,9 @@ <hr /><hr /> <a NAME="HistoryCompleter" ID="HistoryCompleter"></a> <h2>HistoryCompleter</h2> - +<p> + Class implementing a completer for the browser history. +</p> <h3>Derived from</h3> QCompleter <h3>Class Attributes</h3> @@ -229,9 +231,9 @@ <p> Public method to check the model for validity. </p><dl> -<dt><i>flag</i></dt> +<dt>Returns:</dt> <dd> -indicating a valid status (boolean) +flag indicating a valid status (boolean) </dd> </dl><a NAME="HistoryCompletionModel.lessThan" ID="HistoryCompletionModel.lessThan"></a> <h4>HistoryCompletionModel.lessThan</h4> @@ -354,6 +356,11 @@ <dd> row number (integer) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +desired row height (integer) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.History.HistoryFilterModel.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.History.HistoryFilterModel.html Sun Sep 29 18:23:27 2013 +0200 @@ -457,9 +457,9 @@ </dd><dt><i>count</i></dt> <dd> number of entries to remove (integer) -</dd><dt><i>index</i></dt> +</dd><dt><i>parent</i></dt> <dd> -of the parent entry (QModelIndex) +index of the parent entry (QModelIndex) </dd> </dl><dl> <dt>Returns:</dt>
--- a/Documentation/Source/eric5.Helpviewer.History.HistoryModel.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.History.HistoryModel.html Sun Sep 29 18:23:27 2013 +0200 @@ -188,9 +188,9 @@ </dd><dt><i>count</i></dt> <dd> number of history entries to remove (integer) -</dd><dt><i>index</i></dt> +</dd><dt><i>parent</i></dt> <dd> -of the parent entry (QModelIndex) +index of the parent entry (QModelIndex) </dd> </dl><dl> <dt>Returns:</dt>
--- a/Documentation/Source/eric5.Helpviewer.History.HistoryTreeModel.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.History.HistoryTreeModel.html Sun Sep 29 18:23:27 2013 +0200 @@ -341,9 +341,9 @@ </dd><dt><i>count</i></dt> <dd> number of entries to remove (integer) -</dd><dt><i>index</i></dt> +</dd><dt><i>parent</i></dt> <dd> -of the parent entry (QModelIndex) +index of the parent entry (QModelIndex) </dd> </dl><dl> <dt>Returns:</dt>
--- a/Documentation/Source/eric5.Helpviewer.Network.FollowRedirectReply.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Network.FollowRedirectReply.html Sun Sep 29 18:23:27 2013 +0200 @@ -31,7 +31,7 @@ <table> <tr> <td><a href="#FollowRedirectReply">FollowRedirectReply</a></td> -<td>Class implementing a network reply delegate allowing to check redirects</td> +<td>Class implementing a network reply delegate allowing to check redirects.</td> </tr> </table> <h3>Functions</h3> @@ -42,7 +42,7 @@ <a NAME="FollowRedirectReply" ID="FollowRedirectReply"></a> <h2>FollowRedirectReply</h2> <p> - Class implementing a network reply delegate allowing to check redirects + Class implementing a network reply delegate allowing to check redirects. </p> <h3>Derived from</h3> QObject
--- a/Documentation/Source/eric5.Helpviewer.Network.QtHelpAccessHandler.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Network.QtHelpAccessHandler.html Sun Sep 29 18:23:27 2013 +0200 @@ -94,6 +94,11 @@ <dd> URL to guess the mime type from (QUrl) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +mime type for the given URL (string) +</dd> </dl><a NAME="QtHelpAccessHandler.createRequest" ID="QtHelpAccessHandler.createRequest"></a> <h4>QtHelpAccessHandler.createRequest</h4> <b>createRequest</b>(<i>op, request, outgoingData=None</i>)
--- a/Documentation/Source/eric5.Helpviewer.Network.SchemeAccessHandler.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Network.SchemeAccessHandler.html Sun Sep 29 18:23:27 2013 +0200 @@ -86,7 +86,8 @@ </p><dl> <dt><i>op</i></dt> <dd> -the operation to be performed (QNetworkAccessManager.Operation) +the operation to be performed + (QNetworkAccessManager.Operation) </dd><dt><i>request</i></dt> <dd> reference to the request object (QNetworkRequest) @@ -100,6 +101,12 @@ <dd> reference to the created reply object (QNetworkReply) </dd> +</dl><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that the method must + be implemented by a subclass +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -85,7 +85,12 @@ <b>OpenSearchDialog</b>(<i>parent=None</i>) <p> Constructor -</p><a NAME="OpenSearchDialog.__selectionChanged" ID="OpenSearchDialog.__selectionChanged"></a> +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent object (QWidget) +</dd> +</dl><a NAME="OpenSearchDialog.__selectionChanged" ID="OpenSearchDialog.__selectionChanged"></a> <h4>OpenSearchDialog.__selectionChanged</h4> <b>__selectionChanged</b>(<i>selected, deselected</i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchEditDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchEditDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -73,7 +73,15 @@ <b>OpenSearchEditDialog</b>(<i>engine, parent=None</i>) <p> Constructor -</p><a NAME="OpenSearchEditDialog.accept" ID="OpenSearchEditDialog.accept"></a> +</p><dl> +<dt><i>engine</i></dt> +<dd> +reference to the search engine (OpenSearchEngine) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent object (QWidget) +</dd> +</dl><a NAME="OpenSearchEditDialog.accept" ID="OpenSearchEditDialog.accept"></a> <h4>OpenSearchEditDialog.accept</h4> <b>accept</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchEngine.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchEngine.html Sun Sep 29 18:23:27 2013 +0200 @@ -401,7 +401,7 @@ <p> Public method to set the engine image URL. </p><dl> -<dt><i>description</i></dt> +<dt><i>imageUrl</i></dt> <dd> image URL of the engine (string) </dd> @@ -411,7 +411,7 @@ <p> Public method to set the engine image URL. </p><dl> -<dt><i>description</i></dt> +<dt><i>imageUrl</i></dt> <dd> image URL of the engine (string) </dd>
--- a/Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchManager.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchManager.html Sun Sep 29 18:23:27 2013 +0200 @@ -329,6 +329,11 @@ <dd> name of the engine (string) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating an existing engine (boolean) +</dd> </dl><a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a> <h4>OpenSearchManager.engineForKeyword</h4> <b>engineForKeyword</b>(<i>keyword</i>)
--- a/Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchWriter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchWriter.html Sun Sep 29 18:23:27 2013 +0200 @@ -99,6 +99,11 @@ <dd> reference to the engine (OpenSearchEngine) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Passwords.PasswordWriter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Passwords.PasswordWriter.html Sun Sep 29 18:23:27 2013 +0200 @@ -156,6 +156,11 @@ <dd> list of URLs to never store data for (list of strings) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.QtHelpFiltersDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.QtHelpFiltersDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -31,7 +31,7 @@ <table> <tr> <td><a href="#QtHelpFiltersDialog">QtHelpFiltersDialog</a></td> -<td>Class implementing a dialog to manage the QtHelp filters</td> +<td>Class implementing a dialog to manage the QtHelp filters.</td> </tr> </table> <h3>Functions</h3> @@ -42,7 +42,7 @@ <a NAME="QtHelpFiltersDialog" ID="QtHelpFiltersDialog"></a> <h2>QtHelpFiltersDialog</h2> <p> - Class implementing a dialog to manage the QtHelp filters + Class implementing a dialog to manage the QtHelp filters. </p> <h3>Derived from</h3> QDialog, Ui_QtHelpFiltersDialog
--- a/Documentation/Source/eric5.Helpviewer.SearchWidget.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.SearchWidget.html Sun Sep 29 18:23:27 2013 +0200 @@ -94,7 +94,7 @@ <td>Private slot to enable/disable the find buttons.</td> </tr><tr> <td><a href="#SearchWidget.on_highlightAllCheckBox_toggled">on_highlightAllCheckBox_toggled</a></td> -<td>Private slot to toggle the highlight of all occurences.</td> +<td>Private slot to toggle the highlight of all occurrences.</td> </tr><tr> <td><a href="#SearchWidget.showFind">showFind</a></td> <td>Public method to display this dialog.</td> @@ -196,8 +196,13 @@ <h4>SearchWidget.on_highlightAllCheckBox_toggled</h4> <b>on_highlightAllCheckBox_toggled</b>(<i>checked</i>) <p> - Private slot to toggle the highlight of all occurences. -</p><a NAME="SearchWidget.showFind" ID="SearchWidget.showFind"></a> + Private slot to toggle the highlight of all occurrences. +</p><dl> +<dt><i>checked</i></dt> +<dd> +flag indicating the check box toggle state (boolean) +</dd> +</dl><a NAME="SearchWidget.showFind" ID="SearchWidget.showFind"></a> <h4>SearchWidget.showFind</h4> <b>showFind</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.SpeedDial.Page.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.SpeedDial.Page.html Sun Sep 29 18:23:27 2013 +0200 @@ -80,6 +80,9 @@ </dd><dt><i>title</i></dt> <dd> title of the page (string) +</dd><dt><i>broken</i></dt> +<dd> +flag indicating a broken connection (boolean) </dd> </dl><a NAME="Page.__eq__" ID="Page.__eq__"></a> <h4>Page.__eq__</h4>
--- a/Documentation/Source/eric5.Helpviewer.SpeedDial.SpeedDialWriter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.SpeedDial.SpeedDialWriter.html Sun Sep 29 18:23:27 2013 +0200 @@ -117,6 +117,11 @@ <dd> size of the speed dial pages (integer) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.Sync.SyncHandler.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.Sync.SyncHandler.html Sun Sep 29 18:23:27 2013 +0200 @@ -131,6 +131,12 @@ <dd> flag indicating a forced upload of the files (boolean) </dd> +</dl><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this method + must be implemented by subclasses +</dd> </dl><a NAME="SyncHandler.readFile" ID="SyncHandler.readFile"></a> <h4>SyncHandler.readFile</h4> <b>readFile</b>(<i>fileName, type_</i>) @@ -158,32 +164,68 @@ <b>shutdown</b>(<i></i>) <p> Public method to shut down the handler. -</p><a NAME="SyncHandler.syncBookmarks" ID="SyncHandler.syncBookmarks"></a> +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this method + must be implemented by subclasses +</dd> +</dl><a NAME="SyncHandler.syncBookmarks" ID="SyncHandler.syncBookmarks"></a> <h4>SyncHandler.syncBookmarks</h4> <b>syncBookmarks</b>(<i></i>) <p> Public method to synchronize the bookmarks. -</p><a NAME="SyncHandler.syncHistory" ID="SyncHandler.syncHistory"></a> +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this method + must be implemented by subclasses +</dd> +</dl><a NAME="SyncHandler.syncHistory" ID="SyncHandler.syncHistory"></a> <h4>SyncHandler.syncHistory</h4> <b>syncHistory</b>(<i></i>) <p> Public method to synchronize the history. -</p><a NAME="SyncHandler.syncPasswords" ID="SyncHandler.syncPasswords"></a> +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this method + must be implemented by subclasses +</dd> +</dl><a NAME="SyncHandler.syncPasswords" ID="SyncHandler.syncPasswords"></a> <h4>SyncHandler.syncPasswords</h4> <b>syncPasswords</b>(<i></i>) <p> Public method to synchronize the passwords. -</p><a NAME="SyncHandler.syncSpeedDial" ID="SyncHandler.syncSpeedDial"></a> +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this method + must be implemented by subclasses +</dd> +</dl><a NAME="SyncHandler.syncSpeedDial" ID="SyncHandler.syncSpeedDial"></a> <h4>SyncHandler.syncSpeedDial</h4> <b>syncSpeedDial</b>(<i></i>) <p> Public method to synchronize the speed dial data. -</p><a NAME="SyncHandler.syncUserAgents" ID="SyncHandler.syncUserAgents"></a> +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this method + must be implemented by subclasses +</dd> +</dl><a NAME="SyncHandler.syncUserAgents" ID="SyncHandler.syncUserAgents"></a> <h4>SyncHandler.syncUserAgents</h4> <b>syncUserAgents</b>(<i></i>) <p> Public method to synchronize the user agents. -</p><a NAME="SyncHandler.writeFile" ID="SyncHandler.writeFile"></a> +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this method + must be implemented by subclasses +</dd> +</dl><a NAME="SyncHandler.writeFile" ID="SyncHandler.writeFile"></a> <h4>SyncHandler.writeFile</h4> <b>writeFile</b>(<i>data, fileName, type_, timestamp=0</i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.UrlBar.BookmarkActionSelectionDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.UrlBar.BookmarkActionSelectionDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -21,7 +21,8 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Helpviewer.UrlBar.BookmarkActionSelectionDialog</h1> <p> -Module implementing a dialog to select the action to be performed on the bookmark. +Module implementing a dialog to select the action to be performed on the +bookmark. </p> <h3>Global Attributes</h3> <table> @@ -42,7 +43,8 @@ <a NAME="BookmarkActionSelectionDialog" ID="BookmarkActionSelectionDialog"></a> <h2>BookmarkActionSelectionDialog</h2> <p> - Class implementing a dialog to select the action to be performed on the bookmark. + Class implementing a dialog to select the action to be performed on + the bookmark. </p> <h3>Derived from</h3> QDialog, Ui_BookmarkActionSelectionDialog @@ -92,7 +94,12 @@ <b>getAction</b>(<i></i>) <p> Public method to get the selected action. -</p><a NAME="BookmarkActionSelectionDialog.on_bookmarkPushButton_clicked" ID="BookmarkActionSelectionDialog.on_bookmarkPushButton_clicked"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the associated action +</dd> +</dl><a NAME="BookmarkActionSelectionDialog.on_bookmarkPushButton_clicked" ID="BookmarkActionSelectionDialog.on_bookmarkPushButton_clicked"></a> <h4>BookmarkActionSelectionDialog.on_bookmarkPushButton_clicked</h4> <b>on_bookmarkPushButton_clicked</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.UrlBar.StackedUrlBar.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.UrlBar.StackedUrlBar.html Sun Sep 29 18:23:27 2013 +0200 @@ -116,6 +116,11 @@ <p> Public method to get a reference to the url bar for a given index. </p><dl> +<dt><i>index</i></dt> +<dd> +index of the url bar (integer) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> reference to the url bar for the given index (UrlBar)
--- a/Documentation/Source/eric5.Helpviewer.UrlBar.UrlBar.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.UrlBar.UrlBar.html Sun Sep 29 18:23:27 2013 +0200 @@ -88,7 +88,7 @@ <td>Private slot to handle changes of the text.</td> </tr><tr> <td><a href="#UrlBar.browser">browser</a></td> -<td>Public method to get the associated browser (HelpBrowser)</td> +<td>Public method to get the associated browser.</td> </tr><tr> <td><a href="#UrlBar.dragEnterEvent">dragEnterEvent</a></td> <td>Protected method to handle drag enter events.</td> @@ -202,8 +202,13 @@ <h4>UrlBar.browser</h4> <b>browser</b>(<i></i>) <p> - Public method to get the associated browser (HelpBrowser) -</p><a NAME="UrlBar.dragEnterEvent" ID="UrlBar.dragEnterEvent"></a> + Public method to get the associated browser. +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the associated browser (HelpBrowser) +</dd> +</dl><a NAME="UrlBar.dragEnterEvent" ID="UrlBar.dragEnterEvent"></a> <h4>UrlBar.dragEnterEvent</h4> <b>dragEnterEvent</b>(<i>evt</i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.UserAgent.UserAgentWriter.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.UserAgent.UserAgentWriter.html Sun Sep 29 18:23:27 2013 +0200 @@ -84,7 +84,8 @@ </p><dl> <dt><i>agents</i></dt> <dd> -dictionary with user agent data (host as key, agent string as value) +dictionary with user agent data (host as key, agent + string as value) </dd> </dl><dl> <dt>Returns:</dt> @@ -103,7 +104,13 @@ or device to write to (QIODevice) </dd><dt><i>agents</i></dt> <dd> -dictionary with user agent data (host as key, agent string as value) +dictionary with user agent data (host as key, agent + string as value) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.Helpviewer.VirusTotalApi.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.VirusTotalApi.html Sun Sep 29 18:23:27 2013 +0200 @@ -151,11 +151,6 @@ <dd> ID of the scan to get the report URL for (string) </dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -file scan report URL (string) -</dd> </dl><a NAME="VirusTotalAPI.__getFileScanReportUrlFinished" ID="VirusTotalAPI.__getFileScanReportUrlFinished"></a> <h4>VirusTotalAPI.__getFileScanReportUrlFinished</h4> <b>__getFileScanReportUrlFinished</b>(<i></i>) @@ -184,12 +179,6 @@ <dd> protocol used to access VirusTotal (string) </dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -flag indicating validity (boolean) and an error message in - case of a network error (string) -</dd> </dl><a NAME="VirusTotalAPI.preferencesChanged" ID="VirusTotalAPI.preferencesChanged"></a> <h4>VirusTotalAPI.preferencesChanged</h4> <b>preferencesChanged</b>(<i></i>) @@ -205,11 +194,6 @@ <dd> url to be scanned (QUrl) </dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -flag indicating success (boolean) and the scan ID (string) -</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Helpviewer.WebPlugins.ClickToFlash.ClickToFlash.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.WebPlugins.ClickToFlash.ClickToFlash.html Sun Sep 29 18:23:27 2013 +0200 @@ -123,6 +123,11 @@ <dd> argument values to be checked for (list of strings) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating that this was already accepted (boolean) +</dd> </dl><a NAME="ClickToFlash.__init__" ID="ClickToFlash.__init__"></a> <h4>ClickToFlash (Constructor)</h4> <b>ClickToFlash</b>(<i>plugin, mimeType, url, argumentNames, argumentValues, parent=None</i>)
--- a/Documentation/Source/eric5.Helpviewer.WebPlugins.ClickToFlash.ClickToFlashPlugin.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.WebPlugins.ClickToFlash.ClickToFlashPlugin.html Sun Sep 29 18:23:27 2013 +0200 @@ -182,7 +182,12 @@ <b>isAnonymous</b>(<i></i>) <p> Public method to indicate an anonymous plug-in. -</p><a NAME="ClickToFlashPlugin.metaPlugin" ID="ClickToFlashPlugin.metaPlugin"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating anonymous state (boolean) +</dd> +</dl><a NAME="ClickToFlashPlugin.metaPlugin" ID="ClickToFlashPlugin.metaPlugin"></a> <h4>ClickToFlashPlugin.metaPlugin</h4> <b>metaPlugin</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Helpviewer.WebPlugins.ClickToFlash.ClickToFlashWhitelistDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.WebPlugins.ClickToFlash.ClickToFlashWhitelistDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -31,7 +31,7 @@ <table> <tr> <td><a href="#ClickToFlashWhitelistDialog">ClickToFlashWhitelistDialog</a></td> -<td>Class implementing a dialog to manage the ClickToFlash whitelist</td> +<td>Class implementing a dialog to manage the ClickToFlash whitelist.</td> </tr> </table> <h3>Functions</h3> @@ -42,7 +42,7 @@ <a NAME="ClickToFlashWhitelistDialog" ID="ClickToFlashWhitelistDialog"></a> <h2>ClickToFlashWhitelistDialog</h2> <p> - Class implementing a dialog to manage the ClickToFlash whitelist + Class implementing a dialog to manage the ClickToFlash whitelist. </p> <h3>Derived from</h3> QDialog, Ui_ClickToFlashWhitelistDialog
--- a/Documentation/Source/eric5.Helpviewer.WebPlugins.WebPluginFactory.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.WebPlugins.WebPluginFactory.html Sun Sep 29 18:23:27 2013 +0200 @@ -130,6 +130,11 @@ <dd> name of the plug-in (string) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the named plug-in +</dd> </dl><a NAME="WebPluginFactory.plugins" ID="WebPluginFactory.plugins"></a> <h4>WebPluginFactory.plugins</h4> <b>plugins</b>(<i></i>)
--- a/Documentation/Source/eric5.Helpviewer.WebPlugins.WebPluginInterface.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Helpviewer.WebPlugins.WebPluginInterface.html Sun Sep 29 18:23:27 2013 +0200 @@ -79,7 +79,13 @@ <b>configure</b>(<i></i>) <p> Public method to configure the plug-in. -</p><a NAME="WebPluginInterface.create" ID="WebPluginInterface.create"></a> +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this method + must be implemented by subclasses +</dd> +</dl><a NAME="WebPluginInterface.create" ID="WebPluginInterface.create"></a> <h4>WebPluginInterface.create</h4> <b>create</b>(<i>mimeType, url, argumentNames, argumentValues</i>) <p> @@ -103,12 +109,23 @@ <dd> reference to the created object (QWidget) </dd> +</dl><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this method + must be implemented by subclasses +</dd> </dl><a NAME="WebPluginInterface.isAnonymous" ID="WebPluginInterface.isAnonymous"></a> <h4>WebPluginInterface.isAnonymous</h4> <b>isAnonymous</b>(<i></i>) <p> Public method to indicate an anonymous plug-in. -</p><a NAME="WebPluginInterface.metaPlugin" ID="WebPluginInterface.metaPlugin"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating anonymous state (boolean) +</dd> +</dl><a NAME="WebPluginInterface.metaPlugin" ID="WebPluginInterface.metaPlugin"></a> <h4>WebPluginInterface.metaPlugin</h4> <b>metaPlugin</b>(<i></i>) <p> @@ -118,6 +135,12 @@ <dd> meta plug-in object (QWebPluginFactory.Plugin) </dd> +</dl><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this method + must be implemented by subclasses +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.IconEditor.IconEditorGrid.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.IconEditor.IconEditorGrid.html Sun Sep 29 18:23:27 2013 +0200 @@ -412,7 +412,8 @@ <h4>IconEditorGrid.__drawTool</h4> <b>__drawTool</b>(<i>pos, mark</i>) <p> - Public method to perform a draw operation depending of the current tool. + Public method to perform a draw operation depending of the current + tool. </p><dl> <dt><i>pos</i></dt> <dd> @@ -420,9 +421,11 @@ </dd><dt><i>mark</i></dt> <dd> flag indicating a mark operation (boolean) -</dd><dt><i>flag</i></dt> +</dd> +</dl><dl> +<dt>Returns:</dt> <dd> -indicating a successful draw (boolean) +flag indicating a successful draw (boolean) </dd> </dl><a NAME="IconEditorGrid.__getSelectionImage" ID="IconEditorGrid.__getSelectionImage"></a> <h4>IconEditorGrid.__getSelectionImage</h4> @@ -495,7 +498,11 @@ </dd><dt><i>j</i></dt> <dd> y-coordinate of the pixel in the image (integer) - return rectangle for the given pixel coordinates (QRect) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +rectangle for the given pixel coordinates (QRect) </dd> </dl><a NAME="IconEditorGrid.__setImagePixel" ID="IconEditorGrid.__setImagePixel"></a> <h4>IconEditorGrid.__setImagePixel</h4>
--- a/Documentation/Source/eric5.IconEditor.IconEditorPalette.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.IconEditor.IconEditorPalette.html Sun Sep 29 18:23:27 2013 +0200 @@ -133,12 +133,22 @@ <b>colorChanged</b>(<i>color</i>) <p> Public slot to update the color preview. -</p><a NAME="IconEditorPalette.previewChanged" ID="IconEditorPalette.previewChanged"></a> +</p><dl> +<dt><i>color</i></dt> +<dd> +new color (QColor) +</dd> +</dl><a NAME="IconEditorPalette.previewChanged" ID="IconEditorPalette.previewChanged"></a> <h4>IconEditorPalette.previewChanged</h4> <b>previewChanged</b>(<i>pixmap</i>) <p> Public slot to update the preview. -</p><a NAME="IconEditorPalette.setCompositingMode" ID="IconEditorPalette.setCompositingMode"></a> +</p><dl> +<dt><i>pixmap</i></dt> +<dd> +new preview pixmap (QPixmap) +</dd> +</dl><a NAME="IconEditorPalette.setCompositingMode" ID="IconEditorPalette.setCompositingMode"></a> <h4>IconEditorPalette.setCompositingMode</h4> <b>setCompositingMode</b>(<i>mode</i>) <p>
--- a/Documentation/Source/eric5.IconEditor.IconEditorWindow.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.IconEditor.IconEditorWindow.html Sun Sep 29 18:23:27 2013 +0200 @@ -334,12 +334,22 @@ <b>__saveIcon</b>(<i></i>) <p> Private slot to save the icon. -</p><a NAME="IconEditorWindow.__saveIconAs" ID="IconEditorWindow.__saveIconAs"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> +</dl><a NAME="IconEditorWindow.__saveIconAs" ID="IconEditorWindow.__saveIconAs"></a> <h4>IconEditorWindow.__saveIconAs</h4> <b>__saveIconAs</b>(<i></i>) <p> Private slot to save the icon with a new name. -</p><a NAME="IconEditorWindow.__saveIconFile" ID="IconEditorWindow.__saveIconFile"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> +</dl><a NAME="IconEditorWindow.__saveIconFile" ID="IconEditorWindow.__saveIconFile"></a> <h4>IconEditorWindow.__saveIconFile</h4> <b>__saveIconFile</b>(<i>fileName</i>) <p>
--- a/Documentation/Source/eric5.MultiProject.AddProjectDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.MultiProject.AddProjectDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -121,15 +121,25 @@ Private slot to display a file selection dialog. </p><a NAME="AddProjectDialog.on_filenameEdit_textChanged" ID="AddProjectDialog.on_filenameEdit_textChanged"></a> <h4>AddProjectDialog.on_filenameEdit_textChanged</h4> -<b>on_filenameEdit_textChanged</b>(<i>p0</i>) +<b>on_filenameEdit_textChanged</b>(<i>txt</i>) <p> Private slot called when the project filename has changed. -</p><a NAME="AddProjectDialog.on_nameEdit_textChanged" ID="AddProjectDialog.on_nameEdit_textChanged"></a> +</p><dl> +<dt><i>txt</i></dt> +<dd> +text of the edit (string) +</dd> +</dl><a NAME="AddProjectDialog.on_nameEdit_textChanged" ID="AddProjectDialog.on_nameEdit_textChanged"></a> <h4>AddProjectDialog.on_nameEdit_textChanged</h4> -<b>on_nameEdit_textChanged</b>(<i>p0</i>) +<b>on_nameEdit_textChanged</b>(<i>txt</i>) <p> Private slot called when the project name has changed. -</p> +</p><dl> +<dt><i>txt</i></dt> +<dd> +text of the edit (string) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.MultiProject.MultiProjectBrowser.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.MultiProject.MultiProjectBrowser.html Sun Sep 29 18:23:27 2013 +0200 @@ -122,7 +122,7 @@ <p> Constructor </p><dl> -<dt><i>project</i></dt> +<dt><i>multiProject</i></dt> <dd> reference to the multi project object </dd><dt><i>parent</i></dt> @@ -229,7 +229,12 @@ <b>__projectOpened</b>(<i>projectfile</i>) <p> Private slot to handle the opening of a project. -</p><a NAME="MultiProjectBrowser.__projectRemoved" ID="MultiProjectBrowser.__projectRemoved"></a> +</p><dl> +<dt><i>projectfile</i></dt> +<dd> +file name of the opened project file (string) +</dd> +</dl><a NAME="MultiProjectBrowser.__projectRemoved" ID="MultiProjectBrowser.__projectRemoved"></a> <h4>MultiProjectBrowser.__projectRemoved</h4> <b>__projectRemoved</b>(<i>project</i>) <p>
--- a/Documentation/Source/eric5.Network.IRC.IrcChannelEditDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Network.IRC.IrcChannelEditDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -112,7 +112,12 @@ <b>on_nameEdit_textChanged</b>(<i>txt</i>) <p> Private slot to handle changes of the given name. -</p> +</p><dl> +<dt><i>txt</i></dt> +<dd> +text of the edit (string) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.Network.IRC.IrcChannelWidget.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Network.IRC.IrcChannelWidget.html Sun Sep 29 18:23:27 2013 +0200 @@ -321,16 +321,18 @@ </dd><dt><i>message</i></dt> <dd> message to be shown (string) -</dd><dt><i>isLocal=</i></dt> -<dd> -flag indicating a message related to the local user (boolean) </dd> </dl><a NAME="IrcChannelWidget.__appendMessage" ID="IrcChannelWidget.__appendMessage"></a> <h4>IrcChannelWidget.__appendMessage</h4> <b>__appendMessage</b>(<i>message</i>) <p> Private slot to append a message. -</p><a NAME="IrcChannelWidget.__autoWhoEntry" ID="IrcChannelWidget.__autoWhoEntry"></a> +</p><dl> +<dt><i>message</i></dt> +<dd> +message to be appended (string) +</dd> +</dl><a NAME="IrcChannelWidget.__autoWhoEntry" ID="IrcChannelWidget.__autoWhoEntry"></a> <h4>IrcChannelWidget.__autoWhoEntry</h4> <b>__autoWhoEntry</b>(<i>match</i>) <p> @@ -420,7 +422,11 @@ <dt><i>name</i></dt> <dd> user name and prefixes (string) - return list of privileges and user name (list of string, string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of privileges and user name (list of string, string) </dd> </dl><a NAME="IrcChannelWidget.__findUser" ID="IrcChannelWidget.__findUser"></a> <h4>IrcChannelWidget.__findUser</h4> @@ -443,9 +449,9 @@ <p> Private method to handle a CTCP channel command. </p><dl> -<dt><i>reference</i></dt> +<dt><i>match</i></dt> <dd> -to the match object +reference to the match object </dd> </dl><dl> <dt>Returns:</dt> @@ -981,7 +987,12 @@ <b>on_messages_anchorClicked</b>(<i>url</i>) <p> Private slot to open links in the default browser. -</p><a NAME="IrcChannelWidget.on_messages_copyAvailable" ID="IrcChannelWidget.on_messages_copyAvailable"></a> +</p><dl> +<dt><i>url</i></dt> +<dd> +URL to be opened (QUrl) +</dd> +</dl><a NAME="IrcChannelWidget.on_messages_copyAvailable" ID="IrcChannelWidget.on_messages_copyAvailable"></a> <h4>IrcChannelWidget.on_messages_copyAvailable</h4> <b>on_messages_copyAvailable</b>(<i>yes</i>) <p> @@ -1194,9 +1205,11 @@ <dt><i>icon</i></dt> <dd> icon to be converted (QIcon) -</dd><dt><i>away</i></dt> +</dd> +</dl><dl> +<dt>Returns:</dt> <dd> -icon (QIcon) +away icon (QIcon) </dd> </dl><a NAME="IrcUserItem.__setIcon" ID="IrcUserItem.__setIcon"></a> <h4>IrcUserItem.__setIcon</h4>
--- a/Documentation/Source/eric5.Network.IRC.IrcIdentitiesEditDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Network.IRC.IrcIdentitiesEditDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -159,7 +159,8 @@ <h4>IrcIdentitiesEditDialog.__updateNicknameButtons</h4> <b>__updateNicknameButtons</b>(<i></i>) <p> - Private slot to update the nick name buttons except the up and down buttons. + Private slot to update the nick name buttons except the up and + down buttons. </p><a NAME="IrcIdentitiesEditDialog.__updateNicknameUpDownButtons" ID="IrcIdentitiesEditDialog.__updateNicknameUpDownButtons"></a> <h4>IrcIdentitiesEditDialog.__updateNicknameUpDownButtons</h4> <b>__updateNicknameUpDownButtons</b>(<i></i>) @@ -208,7 +209,12 @@ <b>on_identitiesCombo_currentIndexChanged</b>(<i>identity</i>) <p> Private slot to handle the selection of an identity. -</p><a NAME="IrcIdentitiesEditDialog.on_nicknameAddButton_clicked" ID="IrcIdentitiesEditDialog.on_nicknameAddButton_clicked"></a> +</p><dl> +<dt><i>identity</i></dt> +<dd> +selected identity (string) +</dd> +</dl><a NAME="IrcIdentitiesEditDialog.on_nicknameAddButton_clicked" ID="IrcIdentitiesEditDialog.on_nicknameAddButton_clicked"></a> <h4>IrcIdentitiesEditDialog.on_nicknameAddButton_clicked</h4> <b>on_nicknameAddButton_clicked</b>(<i></i>) <p> @@ -228,7 +234,12 @@ <b>on_nicknameEdit_textEdited</b>(<i>nick</i>) <p> Private slot handling a change of the nick name. -</p><a NAME="IrcIdentitiesEditDialog.on_nicknameUpButton_clicked" ID="IrcIdentitiesEditDialog.on_nicknameUpButton_clicked"></a> +</p><dl> +<dt><i>nick</i></dt> +<dd> +new nick name (string) +</dd> +</dl><a NAME="IrcIdentitiesEditDialog.on_nicknameUpButton_clicked" ID="IrcIdentitiesEditDialog.on_nicknameUpButton_clicked"></a> <h4>IrcIdentitiesEditDialog.on_nicknameUpButton_clicked</h4> <b>on_nicknameUpButton_clicked</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Network.IRC.IrcMessageEdit.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Network.IRC.IrcMessageEdit.html Sun Sep 29 18:23:27 2013 +0200 @@ -145,9 +145,9 @@ <p> Protected slot to support wheel events. </p><dl> -<dt><i>reference</i></dt> +<dt><i>evt</i></dt> <dd> -to the wheel event (QWheelEvent) +reference to the wheel event (QWheelEvent) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.Network.IRC.IrcNetworkListDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Network.IRC.IrcNetworkListDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -185,12 +185,22 @@ <b>on_networksList_itemCollapsed</b>(<i>item</i>) <p> Private slot handling the collapse of a top level item. -</p><a NAME="IrcNetworkListDialog.on_networksList_itemExpanded" ID="IrcNetworkListDialog.on_networksList_itemExpanded"></a> +</p><dl> +<dt><i>item</i></dt> +<dd> +reference to the collapsed item (QTreeWidgetItem) +</dd> +</dl><a NAME="IrcNetworkListDialog.on_networksList_itemExpanded" ID="IrcNetworkListDialog.on_networksList_itemExpanded"></a> <h4>IrcNetworkListDialog.on_networksList_itemExpanded</h4> <b>on_networksList_itemExpanded</b>(<i>item</i>) <p> Private slot handling the expansion of a top level item. -</p><a NAME="IrcNetworkListDialog.on_networksList_itemSelectionChanged" ID="IrcNetworkListDialog.on_networksList_itemSelectionChanged"></a> +</p><dl> +<dt><i>item</i></dt> +<dd> +reference to the expanded item (QTreeWidgetItem) +</dd> +</dl><a NAME="IrcNetworkListDialog.on_networksList_itemSelectionChanged" ID="IrcNetworkListDialog.on_networksList_itemSelectionChanged"></a> <h4>IrcNetworkListDialog.on_networksList_itemSelectionChanged</h4> <b>on_networksList_itemSelectionChanged</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Network.IRC.IrcNetworkManager.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Network.IRC.IrcNetworkManager.html Sun Sep 29 18:23:27 2013 +0200 @@ -444,9 +444,9 @@ <p> Public method to set the identity name. </p><dl> -<dt><i>identity</i></dt> +<dt><i>name</i></dt> <dd> -name (string) +identity name (string) </dd> </dl><a NAME="IrcIdentity.setNickNames" ID="IrcIdentity.setNickNames"></a> <h4>IrcIdentity.setNickNames</h4> @@ -454,7 +454,7 @@ <p> Public method to set the nick names of the identity. </p><dl> -<dt><i>name</i></dt> +<dt><i>names</i></dt> <dd> nick names (list of string) </dd> @@ -800,9 +800,9 @@ <p> Public method to set the network name. </p><dl> -<dt><i>network</i></dt> +<dt><i>name</i></dt> <dd> -name (string) +network name (string) </dd> </dl><a NAME="IrcNetwork.setServer" ID="IrcNetwork.setServer"></a> <h4>IrcNetwork.setServer</h4> @@ -1240,9 +1240,9 @@ <p> Public method to set the server port number. </p><dl> -<dt><i>server</i></dt> +<dt><i>port</i></dt> <dd> -port number (integer) +server port number (integer) </dd> </dl><a NAME="IrcServer.setUseSSL" ID="IrcServer.setUseSSL"></a> <h4>IrcServer.setUseSSL</h4>
--- a/Documentation/Source/eric5.Network.IRC.IrcNetworkWidget.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Network.IRC.IrcNetworkWidget.html Sun Sep 29 18:23:27 2013 +0200 @@ -53,7 +53,8 @@ emitted to indicate the away status </dd><dt>connectNetwork(str,bool)</dt> <dd> -emitted to connect or disconnect from a network +emitted to connect or disconnect from + a network </dd><dt>editNetwork(str)</dt> <dd> emitted to edit a network configuration @@ -192,17 +193,20 @@ <h4>IrcNetworkWidget.__copyAllMessages</h4> <b>__copyAllMessages</b>(<i></i>) <p> - Private slot to copy the contents of the messages display to the clipboard. + Private slot to copy the contents of the messages display to + the clipboard. </p><a NAME="IrcNetworkWidget.__copyMessages" ID="IrcNetworkWidget.__copyMessages"></a> <h4>IrcNetworkWidget.__copyMessages</h4> <b>__copyMessages</b>(<i></i>) <p> - Private slot to copy the selection of the messages display to the clipboard. + Private slot to copy the selection of the messages display to + the clipboard. </p><a NAME="IrcNetworkWidget.__cutAllMessages" ID="IrcNetworkWidget.__cutAllMessages"></a> <h4>IrcNetworkWidget.__cutAllMessages</h4> <b>__cutAllMessages</b>(<i></i>) <p> - Private slot to cut the contents of the messages display to the clipboard. + Private slot to cut the contents of the messages display to + the clipboard. </p><a NAME="IrcNetworkWidget.__initMessagesMenu" ID="IrcNetworkWidget.__initMessagesMenu"></a> <h4>IrcNetworkWidget.__initMessagesMenu</h4> <b>__initMessagesMenu</b>(<i></i>) @@ -338,11 +342,17 @@ <b>on_messages_anchorClicked</b>(<i>url</i>) <p> Private slot to open links in the default browser. -</p><a NAME="IrcNetworkWidget.on_messages_copyAvailable" ID="IrcNetworkWidget.on_messages_copyAvailable"></a> +</p><dl> +<dt><i>url</i></dt> +<dd> +URL to be opened (QUrl) +</dd> +</dl><a NAME="IrcNetworkWidget.on_messages_copyAvailable" ID="IrcNetworkWidget.on_messages_copyAvailable"></a> <h4>IrcNetworkWidget.on_messages_copyAvailable</h4> <b>on_messages_copyAvailable</b>(<i>yes</i>) <p> - Private slot to react to text selection/deselection of the messages edit. + Private slot to react to text selection/deselection of the + messages edit. </p><dl> <dt><i>yes</i></dt> <dd> @@ -353,7 +363,12 @@ <b>on_messages_customContextMenuRequested</b>(<i>pos</i>) <p> Private slot to show the context menu of the messages pane. -</p><a NAME="IrcNetworkWidget.on_networkCombo_currentIndexChanged" ID="IrcNetworkWidget.on_networkCombo_currentIndexChanged"></a> +</p><dl> +<dt><i>pos</i></dt> +<dd> +position the menu should be opened at (QPoint) +</dd> +</dl><a NAME="IrcNetworkWidget.on_networkCombo_currentIndexChanged" ID="IrcNetworkWidget.on_networkCombo_currentIndexChanged"></a> <h4>IrcNetworkWidget.on_networkCombo_currentIndexChanged</h4> <b>on_networkCombo_currentIndexChanged</b>(<i>networkName</i>) <p> @@ -399,9 +414,9 @@ <p> Public slot to set the registered state. </p><dl> -<dt><i>connected</i></dt> +<dt><i>registered</i></dt> <dd> -flag indicating the connection state (boolean) +flag indicating the registration state (boolean) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.Network.IRC.IrcWidget.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Network.IRC.IrcWidget.html Sun Sep 29 18:23:27 2013 +0200 @@ -166,7 +166,7 @@ <td>Public method to initiate the IRC auto connection.</td> </tr><tr> <td><a href="#IrcWidget.isChannelName">isChannelName</a></td> -<td>PublicisChannelName method to check, if the given name is a channel name.</td> +<td>Public method to check, if the given name is a channel name.</td> </tr><tr> <td><a href="#IrcWidget.on_channelsWidget_tabCloseRequested">on_channelsWidget_tabCloseRequested</a></td> <td>Private slot to close a channel by pressing the close button of the channels widget.</td> @@ -261,9 +261,9 @@ <p> Private method to handle a CTCP command. </p><dl> -<dt><i>reference</i></dt> +<dt><i>match</i></dt> <dd> -to the match object +reference to the match object </dd> </dl><dl> <dt>Returns:</dt> @@ -276,9 +276,9 @@ <p> Private method to handle a server message containing a message name. </p><dl> -<dt><i>reference</i></dt> +<dt><i>match</i></dt> <dd> -to the match object +reference to the match object </dd> </dl><dl> <dt>Returns:</dt> @@ -301,9 +301,9 @@ <p> Private method to handle a server message containing a numeric code. </p><dl> -<dt><i>reference</i></dt> +<dt><i>match</i></dt> <dd> -to the match object +reference to the match object </dd> </dl><dl> <dt>Returns:</dt> @@ -406,9 +406,9 @@ <p> Private method to handle a PING message. </p><dl> -<dt><i>reference</i></dt> +<dt><i>match</i></dt> <dd> -to the match object +reference to the match object </dd> </dl><dl> <dt>Returns:</dt> @@ -421,9 +421,9 @@ <p> Private method to handle a new private connection. </p><dl> -<dt><i>reference</i></dt> +<dt><i>match</i></dt> <dd> -to the match object +reference to the match object </dd> </dl><dl> <dt>Returns:</dt> @@ -521,8 +521,13 @@ <h4>IrcWidget.isChannelName</h4> <b>isChannelName</b>(<i>name</i>) <p> - PublicisChannelName method to check, if the given name is a channel name. + Public method to check, if the given name is a channel name. </p><dl> +<dt><i>name</i></dt> +<dd> +name to check (string) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> flag indicating a channel name (boolean)
--- a/Documentation/Source/eric5.PluginManager.PluginInstallDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.PluginManager.PluginInstallDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -279,7 +279,12 @@ <b>on_buttonBox_clicked</b>(<i>button</i>) <p> Private slot to handle the click of a button of the button box. -</p><a NAME="PluginInstallWidget.on_removeArchivesButton_clicked" ID="PluginInstallWidget.on_removeArchivesButton_clicked"></a> +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="PluginInstallWidget.on_removeArchivesButton_clicked" ID="PluginInstallWidget.on_removeArchivesButton_clicked"></a> <h4>PluginInstallWidget.on_removeArchivesButton_clicked</h4> <b>on_removeArchivesButton_clicked</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.PluginManager.PluginManager.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.PluginManager.PluginManager.html Sun Sep 29 18:23:27 2013 +0200 @@ -218,6 +218,11 @@ filename of a plugin to be loaded for development (string) </dd> +</dl><dl> +<dt>Raises <b>PluginPathError</b>:</dt> +<dd> +raised to indicate an invalid plug-in path +</dd> </dl><a NAME="PluginManager.__canActivatePlugin" ID="PluginManager.__canActivatePlugin"></a> <h4>PluginManager.__canActivatePlugin</h4> <b>__canActivatePlugin</b>(<i>module</i>) @@ -234,6 +239,16 @@ flag indicating, if the module satisfies all requirements for being activated (boolean) </dd> +</dl><dl> +<dt>Raises <b>PluginClassFormatError</b>:</dt> +<dd> +raised to indicate an invalid + plug-in class format +</dd><dt>Raises <b>PluginModuleFormatError</b>:</dt> +<dd> +raised to indicate an invalid + plug-in module format +</dd> </dl><a NAME="PluginManager.__canDeactivatePlugin" ID="PluginManager.__canDeactivatePlugin"></a> <h4>PluginManager.__canDeactivatePlugin</h4> <b>__canDeactivatePlugin</b>(<i>module</i>) @@ -324,6 +339,12 @@ <dd> reference to the initialized plugin object </dd> +</dl><dl> +<dt>Raises <b>PluginActivationError</b>:</dt> +<dd> +raised to indicate an issue during the + plug-in activation +</dd> </dl><a NAME="PluginManager.activatePlugins" ID="PluginManager.activatePlugins"></a> <h4>PluginManager.activatePlugins</h4> <b>activatePlugins</b>(<i></i>) @@ -402,7 +423,12 @@ <dt>reference to configuration page</dt> <dd>This will be used by the configuration dialog and must always be None</dd> </dl> -</p><a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +plug-in configuration data +</dd> +</dl><a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> <h4>PluginManager.getPluginDetails</h4> <b>getPluginDetails</b>(<i>name</i>) <p> @@ -423,6 +449,11 @@ <p> Public method to get the path of a plugin directory. </p><dl> +<dt><i>key</i></dt> +<dd> +key of the plug-in directory (string) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> path of the requested plugin directory (string) @@ -566,8 +597,19 @@ <p> Public method to create a plugin object for the named on demand plugin. </p><p> - Note: The plugin is not activated. -</p><a NAME="PluginManager.initOnDemandPlugins" ID="PluginManager.initOnDemandPlugins"></a> + Note: The plug-in is not activated. +</p><dl> +<dt><i>name</i></dt> +<dd> +name of the plug-in (string) +</dd> +</dl><dl> +<dt>Raises <b>PluginActivationError</b>:</dt> +<dd> +raised to indicate an issue during the + plug-in activation +</dd> +</dl><a NAME="PluginManager.initOnDemandPlugins" ID="PluginManager.initOnDemandPlugins"></a> <h4>PluginManager.initOnDemandPlugins</h4> <b>initOnDemandPlugins</b>(<i></i>) <p> @@ -642,6 +684,12 @@ <dd> flag indicating to reload the module (boolean) </dd> +</dl><dl> +<dt>Raises <b>PluginLoadError</b>:</dt> +<dd> +raised to indicate an issue loading + the plug-in +</dd> </dl><a NAME="PluginManager.preferencesChanged" ID="PluginManager.preferencesChanged"></a> <h4>PluginManager.preferencesChanged</h4> <b>preferencesChanged</b>(<i></i>)
--- a/Documentation/Source/eric5.PluginManager.PluginRepositoryDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.PluginManager.PluginRepositoryDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -212,6 +212,10 @@ <dt><i>parent</i></dt> <dd> parent of this dialog (QWidget) +</dd><dt><i>external</i></dt> +<dd> +flag indicating an instatiation as a main + window (boolean) </dd> </dl><a NAME="PluginRepositoryWidget.__downloadCancel" ID="PluginRepositoryWidget.__downloadCancel"></a> <h4>PluginRepositoryWidget.__downloadCancel</h4> @@ -411,7 +415,12 @@ <b>on_buttonBox_clicked</b>(<i>button</i>) <p> Private slot to handle the click of a button of the button box. -</p><a NAME="PluginRepositoryWidget.on_repositoryList_currentItemChanged" ID="PluginRepositoryWidget.on_repositoryList_currentItemChanged"></a> +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="PluginRepositoryWidget.on_repositoryList_currentItemChanged" ID="PluginRepositoryWidget.on_repositoryList_currentItemChanged"></a> <h4>PluginRepositoryWidget.on_repositoryList_currentItemChanged</h4> <b>on_repositoryList_currentItemChanged</b>(<i>current, previous</i>) <p>
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -475,6 +475,11 @@ <dd> arguments for the message (list) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +error code (string) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html Sun Sep 29 18:23:27 2013 +0200 @@ -76,130 +76,130 @@ <td>Private method to extract the index of all the starts and ends of lines.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD111">__fixD111</a></td> -<td>Private method to fix docstring enclosed in wrong quotes (D111).</td> +<td>Private method to fix docstring enclosed in wrong quotes.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD112">__fixD112</a></td> -<td>Private method to fix docstring 'r' or 'u' in leading quotes (D112, D113).</td> +<td>Private method to fix docstring 'r' or 'u' in leading quotes.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD121">__fixD121</a></td> -<td>Private method to fix a single line docstring on multiple lines (D121).</td> +<td>Private method to fix a single line docstring on multiple lines.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD131">__fixD131</a></td> -<td>Private method to fix a docstring summary not ending with a period (D131).</td> +<td>Private method to fix a docstring summary not ending with a period.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD141">__fixD141</a></td> -<td>Private method to fix a function/method docstring preceded by a blank line (D141).</td> +<td>Private method to fix a function/method docstring preceded by a blank line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD142">__fixD142</a></td> -<td>Private method to fix a class docstring not preceded by a blank line (D142).</td> +<td>Private method to fix a class docstring not preceded by a blank line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD143">__fixD143</a></td> -<td>Private method to fix a class docstring not followed by a blank line (D143).</td> +<td>Private method to fix a class docstring not followed by a blank line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD144">__fixD144</a></td> -<td>Private method to fix a docstring summary not followed by a blank line (D144).</td> +<td>Private method to fix a docstring summary not followed by a blank line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD145">__fixD145</a></td> -<td>Private method to fix the last paragraph of a multi-line docstring not followed by a blank line (D143).</td> +<td>Private method to fix the last paragraph of a multi-line docstring not followed by a blank line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD221">__fixD221</a></td> -<td>Private method to fix leading and trailing quotes of docstring not on separate lines (D221, D222).</td> +<td>Private method to fix leading and trailing quotes of docstring not on separate lines.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD242">__fixD242</a></td> -<td>Private method to fix a class or function/method docstring preceded by a blank line (D242, D244).</td> +<td>Private method to fix a class or function/method docstring preceded by a blank line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD243">__fixD243</a></td> -<td>Private method to fix a class or function/method docstring followed by a blank line (D243, D245).</td> +<td>Private method to fix a class or function/method docstring followed by a blank line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD247">__fixD247</a></td> -<td>Private method to fix a last paragraph of a docstring followed by a blank line (D247).</td> +<td>Private method to fix a last paragraph of a docstring followed by a blank line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE101">__fixE101</a></td> -<td>Private method to fix obsolete tab usage and indentation errors (E101, E111, W191).</td> +<td>Private method to fix obsolete tab usage and indentation errors.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE121">__fixE121</a></td> -<td>Private method to fix the indentation of continuation lines and closing brackets (E121, E124).</td> +<td>Private method to fix the indentation of continuation lines and closing brackets.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE122">__fixE122</a></td> -<td>Private method to fix a missing indentation of continuation lines (E122).</td> +<td>Private method to fix a missing indentation of continuation lines.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE123">__fixE123</a></td> -<td>Private method to fix the indentation of a closing bracket lines (E123).</td> +<td>Private method to fix the indentation of a closing bracket lines.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE125">__fixE125</a></td> -<td>Private method to fix the indentation of continuation lines not distinguishable from next logical line (E125).</td> +<td>Private method to fix the indentation of continuation lines not distinguishable from next logical line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE126">__fixE126</a></td> -<td>Private method to fix over-indented/under-indented hanging indentation (E126, E133).</td> +<td>Private method to fix over-indented/under-indented hanging indentation.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE127">__fixE127</a></td> -<td>Private method to fix over/under indented lines (E127, E128).</td> +<td>Private method to fix over/under indented lines.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE201">__fixE201</a></td> -<td>Private method to fix extraneous whitespace (E201, E202, E203, E211).</td> +<td>Private method to fix extraneous whitespace.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE221">__fixE221</a></td> -<td>Private method to fix extraneous whitespace around operator or keyword (E221, E222, E223, E224, E225, E226, E227, E228, E241, E242, E271, E272, E273, E274).</td> +<td>Private method to fix extraneous whitespace around operator or keyword.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE231">__fixE231</a></td> <td>Private method to fix missing whitespace after ',;:'.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE251">__fixE251</a></td> -<td>Private method to fix extraneous whitespace around keyword and default parameter equals (E251).</td> +<td>Private method to fix extraneous whitespace around keyword and default parameter equals.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE261">__fixE261</a></td> -<td>Private method to fix whitespace before or after inline comment (E261, E262).</td> +<td>Private method to fix whitespace before or after inline comment.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE301">__fixE301</a></td> -<td>Private method to fix the need for one blank line (E301).</td> +<td>Private method to fix the need for one blank line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE302">__fixE302</a></td> -<td>Private method to fix the need for two blank lines (E302).</td> +<td>Private method to fix the need for two blank lines.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE303">__fixE303</a></td> -<td>Private method to fix superfluous blank lines (E303).</td> +<td>Private method to fix superfluous blank lines.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE304">__fixE304</a></td> -<td>Private method to fix superfluous blank lines after a function decorator (E304).</td> +<td>Private method to fix superfluous blank lines after a function decorator.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE401">__fixE401</a></td> -<td>Private method to fix multiple imports on one line (E401).</td> +<td>Private method to fix multiple imports on one line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE501">__fixE501</a></td> -<td>Private method to fix the long lines by breaking them (E501).</td> +<td>Private method to fix the long lines by breaking them.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE502">__fixE502</a></td> -<td>Private method to fix redundant backslash within brackets (E502).</td> +<td>Private method to fix redundant backslash within brackets.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE701">__fixE701</a></td> -<td>Private method to fix colon-separated compound statements (E701).</td> +<td>Private method to fix colon-separated compound statements.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE702">__fixE702</a></td> -<td>Private method to fix semicolon-separated compound statements (E702, E703).</td> +<td>Private method to fix semicolon-separated compound statements.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE711">__fixE711</a></td> -<td>Private method to fix comparison with None (E711, E712).</td> +<td>Private method to fix comparison with None.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixN804">__fixN804</a></td> -<td>Private method to fix a wrong first argument of normal and class methods (N804, N805).</td> +<td>Private method to fix a wrong first argument of normal and class methods.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixN806">__fixN806</a></td> -<td>Private method to fix a wrong first argument of static methods (N806).</td> +<td>Private method to fix a wrong first argument of static methods.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixReindent">__fixReindent</a></td> <td>Private method to fix a badly indented line.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixW291">__fixW291</a></td> -<td>Private method to fix trailing whitespace (W291, W293).</td> +<td>Private method to fix trailing whitespace.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixW292">__fixW292</a></td> -<td>Private method to fix a missing newline at the end of file (W292).</td> +<td>Private method to fix a missing newline at the end of file.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixW391">__fixW391</a></td> -<td>Private method to fix trailing blank lines (W391).</td> +<td>Private method to fix trailing blank lines.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixW603">__fixW603</a></td> -<td>Private method to fix the not equal notation (W603).</td> +<td>Private method to fix the not equal notation.</td> </tr><tr> <td><a href="#Pep8Fixer.__fixWhitespace">__fixWhitespace</a></td> <td>Private method to correct whitespace at the given offset.</td> @@ -301,7 +301,9 @@ <h4>Pep8Fixer.__fixD111</h4> <b>__fixD111</b>(<i>code, line, pos</i>) <p> - Private method to fix docstring enclosed in wrong quotes (D111). + Private method to fix docstring enclosed in wrong quotes. +</p><p> + Codes: D111 </p><dl> <dt><i>code</i></dt> <dd> @@ -324,8 +326,9 @@ <h4>Pep8Fixer.__fixD112</h4> <b>__fixD112</b>(<i>code, line, pos</i>) <p> - Private method to fix docstring 'r' or 'u' in leading quotes - (D112, D113). + Private method to fix docstring 'r' or 'u' in leading quotes. +</p><p> + Codes: D112, D113 </p><dl> <dt><i>code</i></dt> <dd> @@ -348,7 +351,9 @@ <h4>Pep8Fixer.__fixD121</h4> <b>__fixD121</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix a single line docstring on multiple lines (D121). + Private method to fix a single line docstring on multiple lines. +</p><p> + Codes: D121 </p><dl> <dt><i>code</i></dt> <dd> @@ -376,7 +381,9 @@ <b>__fixD131</b>(<i>code, line, pos</i>) <p> Private method to fix a docstring summary not ending with a - period (D131). + period. +</p><p> + Codes: D131 </p><dl> <dt><i>code</i></dt> <dd> @@ -400,7 +407,9 @@ <b>__fixD141</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix a function/method docstring preceded by a - blank line (D141). + blank line. +</p><p> + Codes: D141 </p><dl> <dt><i>code</i></dt> <dd> @@ -428,7 +437,9 @@ <b>__fixD142</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix a class docstring not preceded by a - blank line (D142). + blank line. +</p><p> + Codes: D142 </p><dl> <dt><i>code</i></dt> <dd> @@ -456,7 +467,9 @@ <b>__fixD143</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix a class docstring not followed by a - blank line (D143). + blank line. +</p><p> + Codes: D143 </p><dl> <dt><i>code</i></dt> <dd> @@ -484,7 +497,9 @@ <b>__fixD144</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix a docstring summary not followed by a - blank line (D144). + blank line. +</p><p> + Codes: D144 </p><dl> <dt><i>code</i></dt> <dd> @@ -512,7 +527,9 @@ <b>__fixD145</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix the last paragraph of a multi-line docstring - not followed by a blank line (D143). + not followed by a blank line. +</p><p> + Codes: D143 </p><dl> <dt><i>code</i></dt> <dd> @@ -540,7 +557,9 @@ <b>__fixD221</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix leading and trailing quotes of docstring - not on separate lines (D221, D222). + not on separate lines. +</p><p> + Codes: D221, D222 </p><dl> <dt><i>code</i></dt> <dd> @@ -568,7 +587,9 @@ <b>__fixD242</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix a class or function/method docstring preceded - by a blank line (D242, D244). + by a blank line. +</p><p> + Codes: D242, D244 </p><dl> <dt><i>code</i></dt> <dd> @@ -596,7 +617,9 @@ <b>__fixD243</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix a class or function/method docstring followed - by a blank line (D243, D245). + by a blank line. +</p><p> + Codes: D243, D245 </p><dl> <dt><i>code</i></dt> <dd> @@ -624,7 +647,9 @@ <b>__fixD247</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix a last paragraph of a docstring followed - by a blank line (D247). + by a blank line. +</p><p> + Codes: D247 </p><dl> <dt><i>code</i></dt> <dd> @@ -651,8 +676,9 @@ <h4>Pep8Fixer.__fixE101</h4> <b>__fixE101</b>(<i>code, line, pos</i>) <p> - Private method to fix obsolete tab usage and indentation errors - (E101, E111, W191). + Private method to fix obsolete tab usage and indentation errors. +</p><p> + Codes: E101, E111, W191 </p><dl> <dt><i>code</i></dt> <dd> @@ -676,7 +702,9 @@ <b>__fixE121</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix the indentation of continuation lines and - closing brackets (E121, E124). + closing brackets. +</p><p> + Codes: E121, E124 </p><dl> <dt><i>code</i></dt> <dd> @@ -703,8 +731,9 @@ <h4>Pep8Fixer.__fixE122</h4> <b>__fixE122</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix a missing indentation of continuation lines - (E122). + Private method to fix a missing indentation of continuation lines. +</p><p> + Codes: E122 </p><dl> <dt><i>code</i></dt> <dd> @@ -731,8 +760,9 @@ <h4>Pep8Fixer.__fixE123</h4> <b>__fixE123</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix the indentation of a closing bracket lines - (E123). + Private method to fix the indentation of a closing bracket lines. +</p><p> + Codes: E123 </p><dl> <dt><i>code</i></dt> <dd> @@ -760,7 +790,9 @@ <b>__fixE125</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix the indentation of continuation lines not - distinguishable from next logical line (E125). + distinguishable from next logical line. +</p><p> + Codes: E125 </p><dl> <dt><i>code</i></dt> <dd> @@ -788,7 +820,9 @@ <b>__fixE126</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix over-indented/under-indented hanging - indentation (E126, E133). + indentation. +</p><p> + Codes: E126, E133 </p><dl> <dt><i>code</i></dt> <dd> @@ -815,7 +849,9 @@ <h4>Pep8Fixer.__fixE127</h4> <b>__fixE127</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix over/under indented lines (E127, E128). + Private method to fix over/under indented lines. +</p><p> + Codes: E127, E128 </p><dl> <dt><i>code</i></dt> <dd> @@ -842,8 +878,9 @@ <h4>Pep8Fixer.__fixE201</h4> <b>__fixE201</b>(<i>code, line, pos</i>) <p> - Private method to fix extraneous whitespace (E201, E202, - E203, E211). + Private method to fix extraneous whitespace. +</p><p> + Codes: E201, E202, E203, E211 </p><dl> <dt><i>code</i></dt> <dd> @@ -867,8 +904,10 @@ <b>__fixE221</b>(<i>code, line, pos</i>) <p> Private method to fix extraneous whitespace around operator or - keyword (E221, E222, E223, E224, E225, E226, E227, E228, E241, - E242, E271, E272, E273, E274). + keyword. +</p><p> + Codes: E221, E222, E223, E224, E225, E226, E227, E228, E241, + E242, E271, E272, E273, E274). </p><dl> <dt><i>code</i></dt> <dd> @@ -892,6 +931,8 @@ <b>__fixE231</b>(<i>code, line, pos</i>) <p> Private method to fix missing whitespace after ',;:'. +</p><p> + Codes: E231 </p><dl> <dt><i>code</i></dt> <dd> @@ -915,7 +956,9 @@ <b>__fixE251</b>(<i>code, line, pos</i>) <p> Private method to fix extraneous whitespace around keyword and - default parameter equals (E251). + default parameter equals. +</p><p> + Codes: E251 </p><dl> <dt><i>code</i></dt> <dd> @@ -938,8 +981,9 @@ <h4>Pep8Fixer.__fixE261</h4> <b>__fixE261</b>(<i>code, line, pos</i>) <p> - Private method to fix whitespace before or after inline comment - (E261, E262). + Private method to fix whitespace before or after inline comment. +</p><p> + Codes: E261, E262 </p><dl> <dt><i>code</i></dt> <dd> @@ -962,7 +1006,9 @@ <h4>Pep8Fixer.__fixE301</h4> <b>__fixE301</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix the need for one blank line (E301). + Private method to fix the need for one blank line. +</p><p> + Codes: E301 </p><dl> <dt><i>code</i></dt> <dd> @@ -989,7 +1035,9 @@ <h4>Pep8Fixer.__fixE302</h4> <b>__fixE302</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix the need for two blank lines (E302). + Private method to fix the need for two blank lines. +</p><p> + Codes: E302 </p><dl> <dt><i>code</i></dt> <dd> @@ -1016,7 +1064,9 @@ <h4>Pep8Fixer.__fixE303</h4> <b>__fixE303</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix superfluous blank lines (E303). + Private method to fix superfluous blank lines. +</p><p> + Codes: E303 </p><dl> <dt><i>code</i></dt> <dd> @@ -1044,7 +1094,9 @@ <b>__fixE304</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix superfluous blank lines after a function - decorator (E304). + decorator. +</p><p> + Codes: E304 </p><dl> <dt><i>code</i></dt> <dd> @@ -1071,7 +1123,9 @@ <h4>Pep8Fixer.__fixE401</h4> <b>__fixE401</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix multiple imports on one line (E401). + Private method to fix multiple imports on one line. +</p><p> + Codes: E401 </p><dl> <dt><i>code</i></dt> <dd> @@ -1098,7 +1152,9 @@ <h4>Pep8Fixer.__fixE501</h4> <b>__fixE501</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix the long lines by breaking them (E501). + Private method to fix the long lines by breaking them. +</p><p> + Codes: E501 </p><dl> <dt><i>code</i></dt> <dd> @@ -1125,7 +1181,9 @@ <h4>Pep8Fixer.__fixE502</h4> <b>__fixE502</b>(<i>code, line, pos</i>) <p> - Private method to fix redundant backslash within brackets (E502). + Private method to fix redundant backslash within brackets. +</p><p> + Codes: E502 </p><dl> <dt><i>code</i></dt> <dd> @@ -1148,7 +1206,9 @@ <h4>Pep8Fixer.__fixE701</h4> <b>__fixE701</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix colon-separated compound statements (E701). + Private method to fix colon-separated compound statements. +</p><p> + Codes: E701 </p><dl> <dt><i>code</i></dt> <dd> @@ -1175,8 +1235,9 @@ <h4>Pep8Fixer.__fixE702</h4> <b>__fixE702</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix semicolon-separated compound statements - (E702, E703). + Private method to fix semicolon-separated compound statements. +</p><p> + Codes: E702, E703 </p><dl> <dt><i>code</i></dt> <dd> @@ -1203,7 +1264,9 @@ <h4>Pep8Fixer.__fixE711</h4> <b>__fixE711</b>(<i>code, line, pos</i>) <p> - Private method to fix comparison with None (E711, E712). + Private method to fix comparison with None. +</p><p> + Codes: E711, E712 </p><dl> <dt><i>code</i></dt> <dd> @@ -1227,7 +1290,9 @@ <b>__fixN804</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix a wrong first argument of normal and - class methods (N804, N805). + class methods. +</p><p> + Codes: N804, N805 </p><dl> <dt><i>code</i></dt> <dd> @@ -1254,8 +1319,9 @@ <h4>Pep8Fixer.__fixN806</h4> <b>__fixN806</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix a wrong first argument of static methods - (N806). + Private method to fix a wrong first argument of static methods. +</p><p> + Codes: N806 </p><dl> <dt><i>code</i></dt> <dd> @@ -1292,6 +1358,9 @@ </dd><dt><i>pos</i></dt> <dd> position inside line (integer) +</dd><dt><i>logical</i></dt> +<dd> +logical line structure </dd> </dl><dl> <dt>Returns:</dt> @@ -1302,7 +1371,9 @@ <h4>Pep8Fixer.__fixW291</h4> <b>__fixW291</b>(<i>code, line, pos</i>) <p> - Private method to fix trailing whitespace (W291, W293). + Private method to fix trailing whitespace. +</p><p> + Codes: W291, W293 </p><dl> <dt><i>code</i></dt> <dd> @@ -1325,7 +1396,9 @@ <h4>Pep8Fixer.__fixW292</h4> <b>__fixW292</b>(<i>code, line, pos</i>) <p> - Private method to fix a missing newline at the end of file (W292). + Private method to fix a missing newline at the end of file. +</p><p> + Codes: W292 </p><dl> <dt><i>code</i></dt> <dd> @@ -1348,7 +1421,9 @@ <h4>Pep8Fixer.__fixW391</h4> <b>__fixW391</b>(<i>code, line, pos</i>) <p> - Private method to fix trailing blank lines (W391). + Private method to fix trailing blank lines. +</p><p> + Codes: W391 </p><dl> <dt><i>code</i></dt> <dd> @@ -1371,7 +1446,9 @@ <h4>Pep8Fixer.__fixW603</h4> <b>__fixW603</b>(<i>code, line, pos</i>) <p> - Private method to fix the not equal notation (W603). + Private method to fix the not equal notation. +</p><p> + Codes: W603 </p><dl> <dt><i>code</i></dt> <dd> @@ -1496,7 +1573,12 @@ <b>finalize</b>(<i></i>) <p> Public method to apply all deferred fixes. -</p><a NAME="Pep8Fixer.fixIssue" ID="Pep8Fixer.fixIssue"></a> +</p><dl> +<dt>Returns:</dt> +<dd> +dictionary containing the fix results +</dd> +</dl><a NAME="Pep8Fixer.fixIssue" ID="Pep8Fixer.fixIssue"></a> <h4>Pep8Fixer.fixIssue</h4> <b>fixIssue</b>(<i>line, pos, message</i>) <p> @@ -1809,7 +1891,7 @@ Private method to remove multiline-related code that will cause syntax error. </p><dl> -<dt><i>line</i></dt> +<dt><i>text</i></dt> <dd> code line to work on (string) </dd> @@ -1935,6 +2017,11 @@ <dd> tokens generator (tokenize._tokenize) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the generated statistics +</dd> </dl><a NAME="Pep8Reindenter.__getlspace" ID="Pep8Reindenter.__getlspace"></a> <h4>Pep8Reindenter.__getlspace</h4> <b>__getlspace</b>(<i>line</i>) @@ -1980,7 +2067,12 @@ <b>run</b>(<i></i>) <p> Public method to run the re-indenter. -</p> +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating that a change was done (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html Sun Sep 29 18:23:27 2013 +0200 @@ -85,7 +85,7 @@ <td>Private method to check local variables in functions (N821).</td> </tr><tr> <td><a href="#Pep8NamingChecker.__error">__error</a></td> -<td>Private method to build the error information</td> +<td>Private method to build the error information.</td> </tr><tr> <td><a href="#Pep8NamingChecker.__findGlobalDefs">__findGlobalDefs</a></td> <td>Private method amend a node with global definitions information.</td> @@ -161,6 +161,9 @@ <dt><i>node</i></dt> <dd> AST note to check +</dd><dt><i>parents</i></dt> +<dd> +list of parent nodes </dd> </dl><dl> <dt>Returns:</dt> @@ -182,6 +185,9 @@ <dt><i>node</i></dt> <dd> AST note to check +</dd><dt><i>parents</i></dt> +<dd> +list of parent nodes </dd> </dl><dl> <dt>Returns:</dt> @@ -205,6 +211,9 @@ <dt><i>node</i></dt> <dd> AST note to check +</dd><dt><i>parents</i></dt> +<dd> +list of parent nodes </dd> </dl><dl> <dt>Returns:</dt> @@ -222,6 +231,9 @@ <dt><i>node</i></dt> <dd> AST note to check +</dd><dt><i>parents</i></dt> +<dd> +list of parent nodes </dd> </dl><dl> <dt>Returns:</dt> @@ -240,6 +252,9 @@ <dt><i>node</i></dt> <dd> AST note to check +</dd><dt><i>parents</i></dt> +<dd> +list of parent nodes </dd> </dl><dl> <dt>Returns:</dt> @@ -256,6 +271,9 @@ <dt><i>node</i></dt> <dd> AST note to check +</dd><dt><i>parents</i></dt> +<dd> +list of parent nodes </dd> </dl><dl> <dt>Returns:</dt> @@ -274,6 +292,9 @@ <dt><i>node</i></dt> <dd> AST note to check +</dd><dt><i>parents</i></dt> +<dd> +list of parent nodes </dd> </dl><dl> <dt>Returns:</dt> @@ -285,7 +306,7 @@ <h4>Pep8NamingChecker.__error</h4> <b>__error</b>(<i>node, code</i>) <p> - Private method to build the error information + Private method to build the error information. </p><dl> <dt><i>node</i></dt> <dd>
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -76,9 +76,9 @@ <p> Constructor </p><dl> -<dt><i>dictionary</i></dt> +<dt><i>statistics</i></dt> <dd> -with the statistical data +dictionary with the statistical data </dd><dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget)
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Tabnanny.Tabnanny.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Tabnanny.Tabnanny.html Sun Sep 29 18:23:27 2013 +0200 @@ -48,7 +48,7 @@ <table> <tr> <td><a href="#NannyNag">NannyNag</a></td> -<td>Raised by tokeneater() if detecting an ambiguous indent.</td> +<td>Class implementing an exception for indentation issues.</td> </tr><tr> <td><a href="#Whitespace">Whitespace</a></td> <td>Class implementing the whitespace checker.</td> @@ -71,6 +71,8 @@ <a NAME="NannyNag" ID="NannyNag"></a> <h2>NannyNag</h2> <p> + Class implementing an exception for indentation issues. +</p><p> Raised by tokeneater() if detecting an ambiguous indent. Captured and handled in check(). </p> @@ -357,6 +359,11 @@ <dd> list of tokens </dd> +</dl><dl> +<dt>Raises <b>NannyNag</b>:</dt> +<dd> +raised to indicate an indentation error +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -319,7 +319,7 @@ </dd> </dl><a NAME="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged"></a> <h4>EricdocConfigDialog.on_qtHelpTitleEdit_textChanged</h4> -<b>on_qtHelpTitleEdit_textChanged</b>(<i>p0</i>) +<b>on_qtHelpTitleEdit_textChanged</b>(<i>txt</i>) <p> Private slot to check the title. </p><dl>
--- a/Documentation/Source/eric5.Plugins.PluginVcsMercurial.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginVcsMercurial.html Sun Sep 29 18:23:27 2013 +0200 @@ -192,6 +192,11 @@ <p> Module function to create the configuration page. </p><dl> +<dt><i>configDlg</i></dt> +<dd> +reference to the configuration dialog (QDialog) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> reference to the configuration page
--- a/Documentation/Source/eric5.Plugins.PluginVcsPySvn.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginVcsPySvn.html Sun Sep 29 18:23:27 2013 +0200 @@ -152,9 +152,6 @@ <dt><i>key</i></dt> <dd> the key of the value to get -</dd><dt><i>prefClass</i></dt> -<dd> -preferences class used as the storage area </dd> </dl><dl> <dt>Returns:</dt> @@ -198,9 +195,6 @@ </dd><dt><i>value</i></dt> <dd> the value to be set -</dd><dt><i>prefClass</i></dt> -<dd> -preferences class used as the storage area </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -211,6 +205,11 @@ <p> Module function to create the configuration page. </p><dl> +<dt><i>configDlg</i></dt> +<dd> +reference to the configuration dialog (QDialog) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> reference to the configuration page
--- a/Documentation/Source/eric5.Plugins.PluginVcsSubversion.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginVcsSubversion.html Sun Sep 29 18:23:27 2013 +0200 @@ -205,6 +205,11 @@ <p> Module function to create the configuration page. </p><dl> +<dt><i>configDlg</i></dt> +<dd> +reference to the configuration dialog (QDialog) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> reference to the configuration page
--- a/Documentation/Source/eric5.Plugins.PluginWizardE5MessageBox.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginWizardE5MessageBox.html Sun Sep 29 18:23:27 2013 +0200 @@ -64,7 +64,7 @@ <td>Private method to display a dialog and get the code.</td> </tr><tr> <td><a href="#E5MessageBoxWizard.__handle">__handle</a></td> -<td>Private method to handle the wizards action</td> +<td>Private method to handle the wizards action.</td> </tr><tr> <td><a href="#E5MessageBoxWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> @@ -112,7 +112,7 @@ <h4>E5MessageBoxWizard.__handle</h4> <b>__handle</b>(<i></i>) <p> - Private method to handle the wizards action + Private method to handle the wizards action. </p><a NAME="E5MessageBoxWizard.__initAction" ID="E5MessageBoxWizard.__initAction"></a> <h4>E5MessageBoxWizard.__initAction</h4> <b>__initAction</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.PluginWizardPyRegExp.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginWizardPyRegExp.html Sun Sep 29 18:23:27 2013 +0200 @@ -64,7 +64,7 @@ <td>Private method to display a dialog and get the code.</td> </tr><tr> <td><a href="#PyRegExpWizard.__handle">__handle</a></td> -<td>Private method to handle the wizards action</td> +<td>Private method to handle the wizards action.</td> </tr><tr> <td><a href="#PyRegExpWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> @@ -112,7 +112,7 @@ <h4>PyRegExpWizard.__handle</h4> <b>__handle</b>(<i></i>) <p> - Private method to handle the wizards action + Private method to handle the wizards action. </p><a NAME="PyRegExpWizard.__initAction" ID="PyRegExpWizard.__initAction"></a> <h4>PyRegExpWizard.__initAction</h4> <b>__initAction</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.PluginWizardQColorDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginWizardQColorDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -64,7 +64,7 @@ <td>Private method to display a dialog and get the code.</td> </tr><tr> <td><a href="#ColorDialogWizard.__handle">__handle</a></td> -<td>Private method to handle the wizards action</td> +<td>Private method to handle the wizards action.</td> </tr><tr> <td><a href="#ColorDialogWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> @@ -112,7 +112,7 @@ <h4>ColorDialogWizard.__handle</h4> <b>__handle</b>(<i></i>) <p> - Private method to handle the wizards action + Private method to handle the wizards action. </p><a NAME="ColorDialogWizard.__initAction" ID="ColorDialogWizard.__initAction"></a> <h4>ColorDialogWizard.__initAction</h4> <b>__initAction</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.PluginWizardQFileDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginWizardQFileDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -64,7 +64,7 @@ <td>Private method to display a dialog and get the code.</td> </tr><tr> <td><a href="#FileDialogWizard.__handle">__handle</a></td> -<td>Private method to handle the wizards action</td> +<td>Private method to handle the wizards action.</td> </tr><tr> <td><a href="#FileDialogWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> @@ -112,7 +112,7 @@ <h4>FileDialogWizard.__handle</h4> <b>__handle</b>(<i></i>) <p> - Private method to handle the wizards action + Private method to handle the wizards action. </p><a NAME="FileDialogWizard.__initAction" ID="FileDialogWizard.__initAction"></a> <h4>FileDialogWizard.__initAction</h4> <b>__initAction</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.PluginWizardQFontDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginWizardQFontDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -64,7 +64,7 @@ <td>Private method to display a dialog and get the code.</td> </tr><tr> <td><a href="#FontDialogWizard.__handle">__handle</a></td> -<td>Private method to handle the wizards action</td> +<td>Private method to handle the wizards action.</td> </tr><tr> <td><a href="#FontDialogWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> @@ -112,7 +112,7 @@ <h4>FontDialogWizard.__handle</h4> <b>__handle</b>(<i></i>) <p> - Private method to handle the wizards action + Private method to handle the wizards action. </p><a NAME="FontDialogWizard.__initAction" ID="FontDialogWizard.__initAction"></a> <h4>FontDialogWizard.__initAction</h4> <b>__initAction</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.PluginWizardQInputDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginWizardQInputDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -64,7 +64,7 @@ <td>Private method to display a dialog and get the code.</td> </tr><tr> <td><a href="#InputDialogWizard.__handle">__handle</a></td> -<td>Private method to handle the wizards action</td> +<td>Private method to handle the wizards action.</td> </tr><tr> <td><a href="#InputDialogWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> @@ -112,7 +112,7 @@ <h4>InputDialogWizard.__handle</h4> <b>__handle</b>(<i></i>) <p> - Private method to handle the wizards action + Private method to handle the wizards action. </p><a NAME="InputDialogWizard.__initAction" ID="InputDialogWizard.__initAction"></a> <h4>InputDialogWizard.__initAction</h4> <b>__initAction</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.PluginWizardQMessageBox.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginWizardQMessageBox.html Sun Sep 29 18:23:27 2013 +0200 @@ -64,7 +64,7 @@ <td>Private method to display a dialog and get the code.</td> </tr><tr> <td><a href="#MessageBoxWizard.__handle">__handle</a></td> -<td>Private method to handle the wizards action</td> +<td>Private method to handle the wizards action.</td> </tr><tr> <td><a href="#MessageBoxWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> @@ -112,7 +112,7 @@ <h4>MessageBoxWizard.__handle</h4> <b>__handle</b>(<i></i>) <p> - Private method to handle the wizards action + Private method to handle the wizards action. </p><a NAME="MessageBoxWizard.__initAction" ID="MessageBoxWizard.__initAction"></a> <h4>MessageBoxWizard.__initAction</h4> <b>__initAction</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.PluginWizardQRegExp.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginWizardQRegExp.html Sun Sep 29 18:23:27 2013 +0200 @@ -64,7 +64,7 @@ <td>Private method to display a dialog and get the code.</td> </tr><tr> <td><a href="#QRegExpWizard.__handle">__handle</a></td> -<td>Private method to handle the wizards action</td> +<td>Private method to handle the wizards action.</td> </tr><tr> <td><a href="#QRegExpWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> @@ -112,7 +112,7 @@ <h4>QRegExpWizard.__handle</h4> <b>__handle</b>(<i></i>) <p> - Private method to handle the wizards action + Private method to handle the wizards action. </p><a NAME="QRegExpWizard.__initAction" ID="QRegExpWizard.__initAction"></a> <h4>QRegExpWizard.__initAction</h4> <b>__initAction</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.PluginWizardQRegularExpression.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.PluginWizardQRegularExpression.html Sun Sep 29 18:23:27 2013 +0200 @@ -64,7 +64,7 @@ <td>Private method to display a dialog and get the code.</td> </tr><tr> <td><a href="#QRegularExpressionWizard.__handle">__handle</a></td> -<td>Private method to handle the wizards action</td> +<td>Private method to handle the wizards action.</td> </tr><tr> <td><a href="#QRegularExpressionWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> @@ -112,7 +112,7 @@ <h4>QRegularExpressionWizard.__handle</h4> <b>__handle</b>(<i></i>) <p> - Private method to handle the wizards action + Private method to handle the wizards action. </p><a NAME="QRegularExpressionWizard.__initAction" ID="QRegularExpressionWizard.__initAction"></a> <h4>QRegularExpressionWizard.__initAction</h4> <b>__initAction</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.HgBookmarkDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.HgBookmarkDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -212,7 +212,12 @@ <b>on_nameCombo_activated</b>(<i>txt</i>) <p> Private slot to handle changes of the selected bookmark name. -</p><a NAME="HgBookmarkDialog.on_nameEdit_textChanged" ID="HgBookmarkDialog.on_nameEdit_textChanged"></a> +</p><dl> +<dt><i>txt</i></dt> +<dd> +selected combo entry (string) +</dd> +</dl><a NAME="HgBookmarkDialog.on_nameEdit_textChanged" ID="HgBookmarkDialog.on_nameEdit_textChanged"></a> <h4>HgBookmarkDialog.on_nameEdit_textChanged</h4> <b>on_nameEdit_textChanged</b>(<i>txt</i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.HgBookmarksInOutDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.HgBookmarksInOutDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -130,6 +130,11 @@ <dd> reference to the parent widget (QWidget) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid dialog mode +</dd> </dl><a NAME="HgBookmarksInOutDialog.__finish" ID="HgBookmarksInOutDialog.__finish"></a> <h4>HgBookmarksInOutDialog.__finish</h4> <b>__finish</b>(<i></i>) @@ -267,6 +272,11 @@ <dd> name of directory to be listed (string) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid dialog mode +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.Config.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.Config.html Sun Sep 29 18:23:27 2013 +0200 @@ -21,7 +21,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Plugins.VcsPlugins.vcsMercurial.Config</h1> <p> -Module defining configuration variables for the Mercurial package +Module defining configuration variables for the Mercurial package. </p> <h3>Global Attributes</h3> <table>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgAddSubrepositoryDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgAddSubrepositoryDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -86,7 +86,10 @@ <p> Constructor </p><dl> -<dt><i>parent</i></dt> +<dt><i>projectPath</i></dt> +<dd> +project directory name (string) +</dd><dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -127,7 +127,8 @@ <h4>HgAnnotateDialog.__finish</h4> <b>__finish</b>(<i></i>) <p> - Private slot called when the process finished or the user pressed the button. + Private slot called when the process finished or the user pressed + the button. </p><a NAME="HgAnnotateDialog.__generateItem" ID="HgAnnotateDialog.__generateItem"></a> <h4>HgAnnotateDialog.__generateItem</h4> <b>__generateItem</b>(<i>revision, changeset, author, date, text</i>) @@ -146,7 +147,7 @@ </dd><dt><i>date</i></dt> <dd> date of the tag (string) -</dd><dt><i>name</i></dt> +</dd><dt><i>text</i></dt> <dd> name (path) of the tag (string) </dd>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgArchiveDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgArchiveDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -112,7 +112,12 @@ <b>on_archiveEdit_textChanged</b>(<i>archive</i>) <p> Private slot to handle changes of the archive name. -</p><a NAME="HgArchiveDialog.on_typeComboBox_activated" ID="HgArchiveDialog.on_typeComboBox_activated"></a> +</p><dl> +<dt><i>archive</i></dt> +<dd> +name of the archive (string) +</dd> +</dl><a NAME="HgArchiveDialog.on_typeComboBox_activated" ID="HgArchiveDialog.on_typeComboBox_activated"></a> <h4>HgArchiveDialog.on_typeComboBox_activated</h4> <b>on_typeComboBox_activated</b>(<i>index</i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgClient.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgClient.html Sun Sep 29 18:23:27 2013 +0200 @@ -139,6 +139,11 @@ <dd> message sent by the server (string) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +data entered by the user (string) +</dd> </dl><a NAME="HgClient.__readChannel" ID="HgClient.__readChannel"></a> <h4>HgClient.__readChannel</h4> <b>__readChannel</b>(<i></i>) @@ -173,19 +178,25 @@ </dd><dt><i>inputChannels</i></dt> <dd> dictionary of input channels. The dictionary must - have the keys 'I' and 'L' and each entry must be a function receiving - the number of bytes to write. + have the keys 'I' and 'L' and each entry must be a function + receiving the number of bytes to write. </dd><dt><i>outputChannels</i></dt> <dd> -dictionary of output channels. The dictionary must - have the keys 'o' and 'e' and each entry must be a function receiving - the data. +dictionary of output channels. The dictionary + must have the keys 'o' and 'e' and each entry must be a function + receiving the data. </dd> </dl><dl> <dt>Returns:</dt> <dd> -result code of the command, -1 if the command server wasn't started or - -10, if the command was canceled (integer) +result code of the command, -1 if the command server wasn't + started or -10, if the command was canceled (integer) +</dd> +</dl><dl> +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +raised to indicate an unexpected command + channel </dd> </dl><a NAME="HgClient.__serverFinished" ID="HgClient.__serverFinished"></a> <h4>HgClient.__serverFinished</h4> @@ -266,14 +277,15 @@ If a prompt function is given, this parameter will be ignored. </dd><dt><i>error=</i></dt> <dd> -function receiving error messages from the server (string) +function receiving error messages from the server + (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> -output and errors of the command server (string). In case output - and/or error functions were given, the respective return value will - be an empty string. +output and errors of the command server (string). In case + output and/or error functions were given, the respective return + value will be an empty string. </dd> </dl><a NAME="HgClient.startServer" ID="HgClient.startServer"></a> <h4>HgClient.startServer</h4> @@ -296,7 +308,12 @@ <b>wasCanceled</b>(<i></i>) <p> Public method to check, if the last command was canceled. -</p> +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating the cancel state (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -106,29 +106,25 @@ </p><dl> <dt>Returns:</dt> <dd> -tuple naming the output file name, the list of revisions to export, - and flags indicating to compare against the second parent, to treat all - files as text, to omit dates in the diff headers and to use the git extended - diff format (string, list of strings, boolean, boolean, boolean, boolean) +tuple naming the output file name, the list of revisions to + export, and flags indicating to compare against the second parent, + to treat all files as text, to omit dates in the diff headers and + to use the git extended diff format (string, list of strings, + boolean, boolean, boolean, boolean) </dd> </dl><a NAME="HgExportDialog.on_changesetsEdit_textChanged" ID="HgExportDialog.on_changesetsEdit_textChanged"></a> <h4>HgExportDialog.on_changesetsEdit_textChanged</h4> <b>on_changesetsEdit_textChanged</b>(<i></i>) <p> Private slot to react on changes of the changesets edit. -</p><dl> -<dt><i>txt</i></dt> -<dd> -contents of the line edit (string) -</dd> -</dl><a NAME="HgExportDialog.on_directoryButton_clicked" ID="HgExportDialog.on_directoryButton_clicked"></a> +</p><a NAME="HgExportDialog.on_directoryButton_clicked" ID="HgExportDialog.on_directoryButton_clicked"></a> <h4>HgExportDialog.on_directoryButton_clicked</h4> <b>on_directoryButton_clicked</b>(<i></i>) <p> Private slot called by pressing the export directory selection button. </p><a NAME="HgExportDialog.on_directoryEdit_textChanged" ID="HgExportDialog.on_directoryEdit_textChanged"></a> <h4>HgExportDialog.on_directoryEdit_textChanged</h4> -<b>on_directoryEdit_textChanged</b>(<i>p0</i>) +<b>on_directoryEdit_textChanged</b>(<i>txt</i>) <p> Private slot to react on changes of the export directory edit. </p><dl> @@ -138,7 +134,7 @@ </dd> </dl><a NAME="HgExportDialog.on_patternEdit_textChanged" ID="HgExportDialog.on_patternEdit_textChanged"></a> <h4>HgExportDialog.on_patternEdit_textChanged</h4> -<b>on_patternEdit_textChanged</b>(<i>p0</i>) +<b>on_patternEdit_textChanged</b>(<i>txt</i>) <p> Private slot to react on changes of the export file name pattern edit. </p><dl>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -199,7 +199,7 @@ <td>Private slot to send the input to the merurial process.</td> </tr><tr> <td><a href="#HgLogBrowserDialog.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td> -<td>Private slot called, when the stop on copy/move checkbox is clicked</td> +<td>Private slot called, when the stop on copy/move checkbox is clicked.</td> </tr><tr> <td><a href="#HgLogBrowserDialog.on_toDate_dateChanged">on_toDate_dateChanged</a></td> <td>Private slot called, when the from date changes.</td> @@ -695,8 +695,13 @@ <h4>HgLogBrowserDialog.on_stopCheckBox_clicked</h4> <b>on_stopCheckBox_clicked</b>(<i>checked</i>) <p> - Private slot called, when the stop on copy/move checkbox is clicked -</p><a NAME="HgLogBrowserDialog.on_toDate_dateChanged" ID="HgLogBrowserDialog.on_toDate_dateChanged"></a> + Private slot called, when the stop on copy/move checkbox is clicked. +</p><dl> +<dt><i>checked</i></dt> +<dd> +flag indicating the state of the check box (boolean) +</dd> +</dl><a NAME="HgLogBrowserDialog.on_toDate_dateChanged" ID="HgLogBrowserDialog.on_toDate_dateChanged"></a> <h4>HgLogBrowserDialog.on_toDate_dateChanged</h4> <b>on_toDate_dateChanged</b>(<i>date</i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgMultiRevisionSelectionDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgMultiRevisionSelectionDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -197,12 +197,7 @@ <b>on_changesetsEdit_textChanged</b>(<i></i>) <p> Private slot to handle changes of the Changesets edit. -</p><dl> -<dt><i>txt</i></dt> -<dd> -text of the edit (string) -</dd> -</dl><a NAME="HgMultiRevisionSelectionDialog.on_limitGroup_toggled" ID="HgMultiRevisionSelectionDialog.on_limitGroup_toggled"></a> +</p><a NAME="HgMultiRevisionSelectionDialog.on_limitGroup_toggled" ID="HgMultiRevisionSelectionDialog.on_limitGroup_toggled"></a> <h4>HgMultiRevisionSelectionDialog.on_limitGroup_toggled</h4> <b>on_limitGroup_toggled</b>(<i>checked</i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgPhaseDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgPhaseDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -108,7 +108,12 @@ <b>on_phaseCombo_activated</b>(<i>txt</i>) <p> Private slot to react upon changes of the phase. -</p><a NAME="HgPhaseDialog.on_revisionsEdit_textChanged" ID="HgPhaseDialog.on_revisionsEdit_textChanged"></a> +</p><dl> +<dt><i>txt</i></dt> +<dd> +activated entry (string) +</dd> +</dl><a NAME="HgPhaseDialog.on_revisionsEdit_textChanged" ID="HgPhaseDialog.on_revisionsEdit_textChanged"></a> <h4>HgPhaseDialog.on_revisionsEdit_textChanged</h4> <b>on_revisionsEdit_textChanged</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgTagBranchListDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgTagBranchListDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -130,7 +130,8 @@ <h4>HgTagBranchListDialog.__finish</h4> <b>__finish</b>(<i></i>) <p> - Private slot called when the process finished or the user pressed the button. + Private slot called when the process finished or the user pressed + the button. </p><a NAME="HgTagBranchListDialog.__generateItem" ID="HgTagBranchListDialog.__generateItem"></a> <h4>HgTagBranchListDialog.__generateItem</h4> <b>__generateItem</b>(<i>revision, changeset, status, name</i>) @@ -271,11 +272,12 @@ </dd><dt><i>tags</i></dt> <dd> flag indicating a list of tags is requested - (False = branches, True = tags) + (False = branches, True = tags) </dd><dt><i>tagsList</i></dt> <dd> -reference to string list receiving the tags (list of strings) -</dd><dt><i>allsTagsList</i></dt> +reference to string list receiving the tags + (list of strings) +</dd><dt><i>allTagsList</i></dt> <dd> reference to string list all tags (list of strings) </dd>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html Sun Sep 29 18:23:27 2013 +0200 @@ -98,7 +98,8 @@ directory name of the repository (string) </dd><dt><i>all</i></dt> <dd> -flag indicating to delete all files including ignored ones (boolean) +flag indicating to delete all files including ignored ones + (boolean) </dd> </dl><dl> <dt>Returns:</dt> @@ -116,7 +117,8 @@ file/directory name (string) </dd><dt><i>all</i></dt> <dd> -flag indicating to delete all files including ignored ones (boolean) +flag indicating to delete all files including ignored ones + (boolean) </dd> </dl><a NAME="Purge.hgPurgeList" ID="Purge.hgPurgeList"></a> <h4>Purge.hgPurgeList</h4> @@ -129,7 +131,8 @@ file/directory name (string) </dd><dt><i>all</i></dt> <dd> -flag indicating to list all files including ignored ones (boolean) +flag indicating to list all files including ignored ones + (boolean) </dd> </dl><a NAME="Purge.shutdown" ID="Purge.shutdown"></a> <h4>Purge.shutdown</h4>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListAllGuardsDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListAllGuardsDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -74,7 +74,10 @@ <p> Constructor </p><dl> -<dt><i>parent</i></dt> +<dt><i>vcs</i></dt> +<dd> +reference to the VCS object (Hg) +</dd><dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesNewPatchDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesNewPatchDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -103,6 +103,11 @@ <dd> reference to the parent widget (QWidget) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid dialog mode +</dd> </dl><a NAME="HgQueuesNewPatchDialog.__updateUI" ID="HgQueuesNewPatchDialog.__updateUI"></a> <h4>HgQueuesNewPatchDialog.__updateUI</h4> <b>__updateUI</b>(<i></i>) @@ -138,12 +143,7 @@ <b>on_messageEdit_textChanged</b>(<i></i>) <p> Private slot to handle changes of the patch message. -</p><dl> -<dt><i>txt</i></dt> -<dd> -text of the edit (string) -</dd> -</dl><a NAME="HgQueuesNewPatchDialog.on_nameEdit_textChanged" ID="HgQueuesNewPatchDialog.on_nameEdit_textChanged"></a> +</p><a NAME="HgQueuesNewPatchDialog.on_nameEdit_textChanged" ID="HgQueuesNewPatchDialog.on_nameEdit_textChanged"></a> <h4>HgQueuesNewPatchDialog.on_nameEdit_textChanged</h4> <b>on_nameEdit_textChanged</b>(<i>txt</i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesQueueManagementDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesQueueManagementDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -111,6 +111,11 @@ <dd> reference to the parent widget (QWidget) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid dialog mode +</dd> </dl><a NAME="HgQueuesQueueManagementDialog.__getQueuesList" ID="HgQueuesQueueManagementDialog.__getQueuesList"></a> <h4>HgQueuesQueueManagementDialog.__getQueuesList</h4> <b>__getQueuesList</b>(<i></i>) @@ -147,7 +152,12 @@ <b>on_nameEdit_textChanged</b>(<i>txt</i>) <p> Private slot to handle changes of the entered queue name. -</p><a NAME="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged" ID="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged"></a> +</p><dl> +<dt><i>txt</i></dt> +<dd> +text of the edit (string) +</dd> +</dl><a NAME="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged" ID="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged"></a> <h4>HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged</h4> <b>on_queuesList_itemSelectionChanged</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.ProjectHelper.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.ProjectHelper.html Sun Sep 29 18:23:27 2013 +0200 @@ -414,11 +414,6 @@ <dd> flag indicating a forceful pop (boolean) </dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -flag indicating that the project should be reread (boolean) -</dd> </dl><a NAME="QueuesProjectHelper.__hgQueueRefreshPatch" ID="QueuesProjectHelper.__hgQueueRefreshPatch"></a> <h4>QueuesProjectHelper.__hgQueueRefreshPatch</h4> <b>__hgQueueRefreshPatch</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html Sun Sep 29 18:23:27 2013 +0200 @@ -208,6 +208,11 @@ <dd> list of patches (list of string) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid patch list type +</dd> </dl><a NAME="Queues.getGuardsList" ID="Queues.getGuardsList"></a> <h4>Queues.getGuardsList</h4> <b>getGuardsList</b>(<i>repodir, all=True</i>) @@ -264,6 +269,11 @@ operation to be performed (Queues.QUEUE_DELETE, Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid operation +</dd> </dl><a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a> <h4>Queues.hgQueueFinishAppliedPatches</h4> <b>hgQueueFinishAppliedPatches</b>(<i>name</i>) @@ -423,6 +433,11 @@ <dd> flag indicating that the project should be reread (boolean) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid operation +</dd> </dl><a NAME="Queues.hgQueueRefreshPatch" ID="Queues.hgQueueRefreshPatch"></a> <h4>Queues.hgQueueRefreshPatch</h4> <b>hgQueueRefreshPatch</b>(<i>name, editMessage=False</i>)
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html Sun Sep 29 18:23:27 2013 +0200 @@ -428,12 +428,12 @@ <p> Protected method to create an instance of the VCS status monitor thread. </p><dl> -<dt><i>project</i></dt> +<dt><i>interval</i></dt> +<dd> +check interval for the monitor thread in seconds (integer) +</dd><dt><i>project</i></dt> <dd> reference to the project object (Project) -</dd><dt><i>interval</i></dt> -<dd> -check interval for the monitor thread in seconds (integer) </dd> </dl><dl> <dt>Returns:</dt> @@ -545,6 +545,11 @@ name of the subcommand (string, one of 'good', 'bad', 'skip' or 'reset') </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid bisect subcommand +</dd> </dl><a NAME="Hg.hgBranch" ID="Hg.hgBranch"></a> <h4>Hg.hgBranch</h4> <b>hgBranch</b>(<i>name</i>) @@ -851,6 +856,11 @@ <dd> flag indicating success (boolean) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid phase +</dd> </dl><a NAME="Hg.hgPreviewBundle" ID="Hg.hgPreviewBundle"></a> <h4>Hg.hgPreviewBundle</h4> <b>hgPreviewBundle</b>(<i>name</i>) @@ -962,6 +972,11 @@ <dd> tuple of two revisions (tuple of strings) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid name parameter +</dd> </dl><a NAME="Hg.hgServe" ID="Hg.hgServe"></a> <h4>Hg.hgServe</h4> <b>hgServe</b>(<i>name</i>) @@ -1391,12 +1406,19 @@ <h4>Hg.vcsNewProjectOptionsDialog</h4> <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) <p> - Public method to get a dialog to enter repository info for getting a new project. + Public method to get a dialog to enter repository info for getting a + new project. </p><dl> <dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated options dialog + (HgNewProjectOptionsDialog) +</dd> </dl><a NAME="Hg.vcsOptionsDialog" ID="Hg.vcsOptionsDialog"></a> <h4>Hg.vcsOptionsDialog</h4> <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) @@ -1411,11 +1433,17 @@ name of the project in the repository (string) </dd><dt><i>editable</i></dt> <dd> -flag indicating that the project name is editable (boolean) +flag indicating that the project name is editable + (boolean) </dd><dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated options dialog (HgOptionsDialog) +</dd> </dl><a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a> <h4>Hg.vcsRegisteredState</h4> <b>vcsRegisteredState</b>(<i>name</i>)
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.Config.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.Config.html Sun Sep 29 18:23:27 2013 +0200 @@ -21,7 +21,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Plugins.VcsPlugins.vcsPySvn.Config</h1> <p> -Module defining configuration variables for the subversion package +Module defining configuration variables for the subversion package. </p> <h3>Global Attributes</h3> <table>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -61,7 +61,7 @@ <td>Constructor</td> </tr><tr> <td><a href="#SvnDialog._clientNotifyCallback">_clientNotifyCallback</a></td> -<td>Protected method called by the client to send events</td> +<td>Protected method called by the client to send events.</td> </tr><tr> <td><a href="#SvnDialog.finish">finish</a></td> <td>Public slot called when the process finished or the user pressed the button.</td> @@ -110,7 +110,7 @@ <h4>SvnDialog._clientNotifyCallback</h4> <b>_clientNotifyCallback</b>(<i>eventDict</i>) <p> - Protected method called by the client to send events + Protected method called by the client to send events. </p><dl> <dt><i>eventDict</i></dt> <dd>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnLogBrowserDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnLogBrowserDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -124,7 +124,7 @@ <td>Private slot called, when a filter expression is entered.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td> -<td>Private slot called, when the stop on copy/move checkbox is clicked</td> +<td>Private slot called, when the stop on copy/move checkbox is clicked.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_toDate_dateChanged">on_toDate_dateChanged</a></td> <td>Private slot called, when the from date changes.</td> @@ -353,8 +353,13 @@ <h4>SvnLogBrowserDialog.on_stopCheckBox_clicked</h4> <b>on_stopCheckBox_clicked</b>(<i>checked</i>) <p> - Private slot called, when the stop on copy/move checkbox is clicked -</p><a NAME="SvnLogBrowserDialog.on_toDate_dateChanged" ID="SvnLogBrowserDialog.on_toDate_dateChanged"></a> + Private slot called, when the stop on copy/move checkbox is clicked. +</p><dl> +<dt><i>checked</i></dt> +<dd> +flag indicating the check box state (boolean) +</dd> +</dl><a NAME="SvnLogBrowserDialog.on_toDate_dateChanged" ID="SvnLogBrowserDialog.on_toDate_dateChanged"></a> <h4>SvnLogBrowserDialog.on_toDate_dateChanged</h4> <b>on_toDate_dateChanged</b>(<i>date</i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnLoginDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnLoginDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -84,6 +84,9 @@ <dd> flag indicating, that subversion is willing to save the answers returned (boolean) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) </dd> </dl><a NAME="SvnLoginDialog.getData" ID="SvnLoginDialog.getData"></a> <h4>SvnLoginDialog.getData</h4>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnMergeDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnMergeDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -104,12 +104,7 @@ <b>__enableOkButton</b>(<i></i>) <p> Private method used to enable/disable the OK-button. -</p><dl> -<dt><i>text</i></dt> -<dd> -ignored -</dd> -</dl><a NAME="SvnMergeDialog.getParameters" ID="SvnMergeDialog.getParameters"></a> +</p><a NAME="SvnMergeDialog.getParameters" ID="SvnMergeDialog.getParameters"></a> <h4>SvnMergeDialog.getParameters</h4> <b>getParameters</b>(<i></i>) <p> @@ -125,12 +120,22 @@ <b>on_tag1Combo_editTextChanged</b>(<i>text</i>) <p> Private slot to handle the tag1Combo editTextChanged signal. -</p><a NAME="SvnMergeDialog.on_tag2Combo_editTextChanged" ID="SvnMergeDialog.on_tag2Combo_editTextChanged"></a> +</p><dl> +<dt><i>text</i></dt> +<dd> +text of the combo (string) +</dd> +</dl><a NAME="SvnMergeDialog.on_tag2Combo_editTextChanged" ID="SvnMergeDialog.on_tag2Combo_editTextChanged"></a> <h4>SvnMergeDialog.on_tag2Combo_editTextChanged</h4> <b>on_tag2Combo_editTextChanged</b>(<i>text</i>) <p> Private slot to handle the tag2Combo editTextChanged signal. -</p> +</p><dl> +<dt><i>text</i></dt> +<dd> +text of the combo (string) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnOptionsDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnOptionsDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -109,7 +109,12 @@ <b>on_protocolCombo_activated</b>(<i>protocol</i>) <p> Private slot to switch the status of the directory selection button. -</p><a NAME="SvnOptionsDialog.on_vcsUrlButton_clicked" ID="SvnOptionsDialog.on_vcsUrlButton_clicked"></a> +</p><dl> +<dt><i>protocol</i></dt> +<dd> +selected protocol (string) +</dd> +</dl><a NAME="SvnOptionsDialog.on_vcsUrlButton_clicked" ID="SvnOptionsDialog.on_vcsUrlButton_clicked"></a> <h4>SvnOptionsDialog.on_vcsUrlButton_clicked</h4> <b>on_vcsUrlButton_clicked</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -335,6 +335,11 @@ <p> Private method to retrieve all entries, that have a locked status. </p><dl> +<dt><i>indicators</i></dt> +<dd> +list of indicators to check against (list of strings) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> list of all items with a locked status
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnTagBranchListDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnTagBranchListDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -180,6 +180,11 @@ flag indicating a list of tags is requested (False = branches, True = tags) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnUrlSelectionDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnUrlSelectionDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -109,7 +109,7 @@ <dt><i>labelCombo</i></dt> <dd> reference to the labelCombo object (QComboBox) -</dd><dt><i>type</i></dt> +</dd><dt><i>type_</i></dt> <dd> type string (string) </dd>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.subversion.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.subversion.html Sun Sep 29 18:23:27 2013 +0200 @@ -418,14 +418,16 @@ <h4>Subversion._createStatusMonitorThread</h4> <b>_createStatusMonitorThread</b>(<i>interval, project</i>) <p> - Protected method to create an instance of the VCS status monitor thread. + Protected method to create an instance of the VCS status monitor + thread. </p><dl> -<dt><i>project</i></dt> +<dt><i>interval</i></dt> +<dd> +check interval for the monitor thread in seconds + (integer) +</dd><dt><i>project</i></dt> <dd> reference to the project object -</dd><dt><i>interval</i></dt> -<dd> -check interval for the monitor thread in seconds (integer) </dd> </dl><dl> <dt>Returns:</dt> @@ -685,8 +687,8 @@ <h4>Subversion.svnSbsDiff</h4> <b>svnSbsDiff</b>(<i>name, extended=False, revisions=None</i>) <p> - Public method used to view the difference of a file to the Mercurial repository - side-by-side. + Public method used to view the difference of a file to the Mercurial + repository side-by-side. </p><dl> <dt><i>name</i></dt> <dd> @@ -698,6 +700,11 @@ <dd> tuple of two revisions (tuple of strings) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid name parameter type +</dd> </dl><a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a> <h4>Subversion.svnSetProp</h4> <b>svnSetProp</b>(<i>name, recursive=False</i>) @@ -1086,12 +1093,19 @@ <h4>Subversion.vcsNewProjectOptionsDialog</h4> <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) <p> - Public method to get a dialog to enter repository info for getting a new project. + Public method to get a dialog to enter repository info for getting a + new project. </p><dl> <dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated options dialog + (SvnNewProjectOptionsDialog) +</dd> </dl><a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a> <h4>Subversion.vcsOptionsDialog</h4> <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) @@ -1106,11 +1120,17 @@ name of the project in the repository (string) </dd><dt><i>editable</i></dt> <dd> -flag indicating that the project name is editable (boolean) +flag indicating that the project name is editable + (boolean) </dd><dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated options dialog (SvnOptionsDialog) +</dd> </dl><a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a> <h4>Subversion.vcsRegisteredState</h4> <b>vcsRegisteredState</b>(<i>name</i>)
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.Config.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.Config.html Sun Sep 29 18:23:27 2013 +0200 @@ -21,7 +21,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Plugins.VcsPlugins.vcsSubversion.Config</h1> <p> -Module defining configuration variables for the subversion package +Module defining configuration variables for the subversion package. </p> <h3>Global Attributes</h3> <table>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -167,7 +167,12 @@ <b>on_recentComboBox_activated</b>(<i>txt</i>) <p> Private slot to select a commit message from recent ones. -</p><a NAME="SvnCommitDialog.showEvent" ID="SvnCommitDialog.showEvent"></a> +</p><dl> +<dt><i>txt</i></dt> +<dd> +text of the combo (string) +</dd> +</dl><a NAME="SvnCommitDialog.showEvent" ID="SvnCommitDialog.showEvent"></a> <h4>SvnCommitDialog.showEvent</h4> <b>showEvent</b>(<i>evt</i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnLogBrowserDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnLogBrowserDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -145,7 +145,7 @@ <td>Private slot to send the input to the subversion process.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td> -<td>Private slot called, when the stop on copy/move checkbox is clicked</td> +<td>Private slot called, when the stop on copy/move checkbox is clicked.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_toDate_dateChanged">on_toDate_dateChanged</a></td> <td>Private slot called, when the from date changes.</td> @@ -429,8 +429,13 @@ <h4>SvnLogBrowserDialog.on_stopCheckBox_clicked</h4> <b>on_stopCheckBox_clicked</b>(<i>checked</i>) <p> - Private slot called, when the stop on copy/move checkbox is clicked -</p><a NAME="SvnLogBrowserDialog.on_toDate_dateChanged" ID="SvnLogBrowserDialog.on_toDate_dateChanged"></a> + Private slot called, when the stop on copy/move checkbox is clicked. +</p><dl> +<dt><i>checked</i></dt> +<dd> +flag indicating the checked state (boolean) +</dd> +</dl><a NAME="SvnLogBrowserDialog.on_toDate_dateChanged" ID="SvnLogBrowserDialog.on_toDate_dateChanged"></a> <h4>SvnLogBrowserDialog.on_toDate_dateChanged</h4> <b>on_toDate_dateChanged</b>(<i>date</i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnMergeDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnMergeDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -104,12 +104,7 @@ <b>__enableOkButton</b>(<i></i>) <p> Private method used to enable/disable the OK-button. -</p><dl> -<dt><i>text</i></dt> -<dd> -ignored -</dd> -</dl><a NAME="SvnMergeDialog.getParameters" ID="SvnMergeDialog.getParameters"></a> +</p><a NAME="SvnMergeDialog.getParameters" ID="SvnMergeDialog.getParameters"></a> <h4>SvnMergeDialog.getParameters</h4> <b>getParameters</b>(<i></i>) <p> @@ -125,12 +120,22 @@ <b>on_tag1Combo_editTextChanged</b>(<i>text</i>) <p> Private slot to handle the tag1Combo editTextChanged signal. -</p><a NAME="SvnMergeDialog.on_tag2Combo_editTextChanged" ID="SvnMergeDialog.on_tag2Combo_editTextChanged"></a> +</p><dl> +<dt><i>text</i></dt> +<dd> +text of the combo (string) +</dd> +</dl><a NAME="SvnMergeDialog.on_tag2Combo_editTextChanged" ID="SvnMergeDialog.on_tag2Combo_editTextChanged"></a> <h4>SvnMergeDialog.on_tag2Combo_editTextChanged</h4> <b>on_tag2Combo_editTextChanged</b>(<i>text</i>) <p> Private slot to handle the tag2Combo editTextChanged signal. -</p> +</p><dl> +<dt><i>text</i></dt> +<dd> +text of the combo (string) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnOptionsDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnOptionsDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -109,7 +109,12 @@ <b>on_protocolCombo_activated</b>(<i>protocol</i>) <p> Private slot to switch the status of the directory selection button. -</p><a NAME="SvnOptionsDialog.on_vcsUrlButton_clicked" ID="SvnOptionsDialog.on_vcsUrlButton_clicked"></a> +</p><dl> +<dt><i>protocol</i></dt> +<dd> +selected protocol (string) +</dd> +</dl><a NAME="SvnOptionsDialog.on_vcsUrlButton_clicked" ID="SvnOptionsDialog.on_vcsUrlButton_clicked"></a> <h4>SvnOptionsDialog.on_vcsUrlButton_clicked</h4> <b>on_vcsUrlButton_clicked</b>(<i></i>) <p>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -158,10 +158,7 @@ <p> Private method to generate a tree item in the repository tree. </p><dl> -<dt><i>parent</i></dt> -<dd> -parent of the item to be created (QTreeWidget or QTreeWidgetItem) -</dd><dt><i>repopath</i></dt> +<dt><i>repopath</i></dt> <dd> path of the item (string) </dd><dt><i>revision</i></dt>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -353,6 +353,11 @@ <p> Private method to retrieve all emtries, that have a locked status. </p><dl> +<dt><i>indicators</i></dt> +<dd> +list of indicators to check against (list of strings) +</dd> +</dl><dl> <dt>Returns:</dt> <dd> list of all items with a locked status
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnTagBranchListDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnTagBranchListDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -245,11 +245,12 @@ </dd><dt><i>tags</i></dt> <dd> flag indicating a list of tags is requested - (False = branches, True = tags) + (False = branches, True = tags) </dd><dt><i>tagsList</i></dt> <dd> -reference to string list receiving the tags (list of strings) -</dd><dt><i>allsTagsList</i></dt> +reference to string list receiving the tags + (list of strings) +</dd><dt><i>allTagsList</i></dt> <dd> reference to string list all tags (list of strings) </dd>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnUrlSelectionDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnUrlSelectionDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -109,7 +109,7 @@ <dt><i>labelCombo</i></dt> <dd> reference to the labelCombo object (QComboBox) -</dd><dt><i>type</i></dt> +</dd><dt><i>type_</i></dt> <dd> type string (string) </dd>
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.subversion.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.subversion.html Sun Sep 29 18:23:27 2013 +0200 @@ -414,12 +414,12 @@ <p> Protected method to create an instance of the VCS status monitor thread. </p><dl> -<dt><i>project</i></dt> +<dt><i>interval</i></dt> +<dd> +check interval for the monitor thread in seconds (integer) +</dd><dt><i>project</i></dt> <dd> reference to the project object -</dd><dt><i>interval</i></dt> -<dd> -check interval for the monitor thread in seconds (integer) </dd> </dl><dl> <dt>Returns:</dt> @@ -656,8 +656,8 @@ <h4>Subversion.svnSbsDiff</h4> <b>svnSbsDiff</b>(<i>name, extended=False, revisions=None</i>) <p> - Public method used to view the difference of a file to the Mercurial repository - side-by-side. + Public method used to view the difference of a file to the Mercurial + repository side-by-side. </p><dl> <dt><i>name</i></dt> <dd> @@ -669,6 +669,11 @@ <dd> tuple of two revisions (tuple of strings) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an illegal name parameter type +</dd> </dl><a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a> <h4>Subversion.svnSetProp</h4> <b>svnSetProp</b>(<i>name, recursive=False</i>) @@ -1057,12 +1062,19 @@ <h4>Subversion.vcsNewProjectOptionsDialog</h4> <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) <p> - Public method to get a dialog to enter repository info for getting a new project. + Public method to get a dialog to enter repository info for getting + a new project. </p><dl> <dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated options dialog + (SvnNewProjectOptionsDialog) +</dd> </dl><a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a> <h4>Subversion.vcsOptionsDialog</h4> <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) @@ -1077,11 +1089,17 @@ name of the project in the repository (string) </dd><dt><i>editable</i></dt> <dd> -flag indicating that the project name is editable (boolean) +flag indicating that the project name is editable + (boolean) </dd><dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated options dialog (SvnOptionsDialog) +</dd> </dl><a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a> <h4>Subversion.vcsRegisteredState</h4> <b>vcsRegisteredState</b>(<i>name</i>) @@ -1172,6 +1190,11 @@ <dd> directory name to be switched (string) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating added or changed files (boolean) +</dd> </dl><a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a> <h4>Subversion.vcsTag</h4> <b>vcsTag</b>(<i>name</i>)
--- a/Documentation/Source/eric5.Plugins.ViewManagerPlugins.Listspace.Listspace.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.ViewManagerPlugins.Listspace.Listspace.html Sun Sep 29 18:23:27 2013 +0200 @@ -246,12 +246,6 @@ <dt><i>parent</i></dt> <dd> parent widget (QWidget) -</dd><dt><i>ui</i></dt> -<dd> -reference to the main user interface -</dd><dt><i>dbs</i></dt> -<dd> -reference to the debug server object </dd> </dl><a NAME="Listspace.__captionChange" ID="Listspace.__captionChange"></a> <h4>Listspace.__captionChange</h4> @@ -342,8 +336,14 @@ <h4>Listspace.__showMenu</h4> <b>__showMenu</b>(<i>point</i>) <p> - Private slot to handle the customContextMenuRequested signal of the viewlist. -</p><a NAME="Listspace.__showSelectedView" ID="Listspace.__showSelectedView"></a> + Private slot to handle the customContextMenuRequested signal of + the viewlist. +</p><dl> +<dt><i>point</i></dt> +<dd> +position to open the menu at (QPoint) +</dd> +</dl><a NAME="Listspace.__showSelectedView" ID="Listspace.__showSelectedView"></a> <h4>Listspace.__showSelectedView</h4> <b>__showSelectedView</b>(<i>row</i>) <p> @@ -357,7 +357,7 @@ <h4>Listspace._addView</h4> <b>_addView</b>(<i>win, fn=None, noName=""</i>) <p> - Protected method to add a view (i.e. window) + Protected method to add a view (i.e. window). </p><dl> <dt><i>win</i></dt> <dd> @@ -391,12 +391,12 @@ <h4>Listspace._removeAllViews</h4> <b>_removeAllViews</b>(<i></i>) <p> - Protected method to remove all views (i.e. windows) + Protected method to remove all views (i.e. windows). </p><a NAME="Listspace._removeView" ID="Listspace._removeView"></a> <h4>Listspace._removeView</h4> <b>_removeView</b>(<i>win</i>) <p> - Protected method to remove a view (i.e. window) + Protected method to remove a view (i.e. window). </p><dl> <dt><i>win</i></dt> <dd> @@ -406,7 +406,7 @@ <h4>Listspace._showView</h4> <b>_showView</b>(<i>win, fn=None</i>) <p> - Protected method to show a view (i.e. window) + Protected method to show a view (i.e. window). </p><dl> <dt><i>win</i></dt> <dd>
--- a/Documentation/Source/eric5.Plugins.ViewManagerPlugins.Tabview.Tabview.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.ViewManagerPlugins.Tabview.Tabview.html Sun Sep 29 18:23:27 2013 +0200 @@ -780,12 +780,6 @@ <dt><i>parent</i></dt> <dd> parent widget (QWidget) -</dd><dt><i>ui</i></dt> -<dd> -reference to the main user interface -</dd><dt><i>dbs</i></dt> -<dd> -reference to the debug server object </dd> </dl><a NAME="Tabview.__currentChanged" ID="Tabview.__currentChanged"></a> <h4>Tabview.__currentChanged</h4> @@ -801,7 +795,7 @@ <h4>Tabview._addView</h4> <b>_addView</b>(<i>win, fn=None, noName=""</i>) <p> - Protected method to add a view (i.e. window) + Protected method to add a view (i.e. window). </p><dl> <dt><i>win</i></dt> <dd> @@ -835,12 +829,12 @@ <h4>Tabview._removeAllViews</h4> <b>_removeAllViews</b>(<i></i>) <p> - Protected method to remove all views (i.e. windows) + Protected method to remove all views (i.e. windows). </p><a NAME="Tabview._removeView" ID="Tabview._removeView"></a> <h4>Tabview._removeView</h4> <b>_removeView</b>(<i>win</i>) <p> - Protected method to remove a view (i.e. window) + Protected method to remove a view (i.e. window). </p><dl> <dt><i>win</i></dt> <dd> @@ -850,7 +844,7 @@ <h4>Tabview._showView</h4> <b>_showView</b>(<i>win, fn=None</i>) <p> - Protected method to show a view (i.e. window) + Protected method to show a view (i.e. window). </p><dl> <dt><i>win</i></dt> <dd> @@ -956,7 +950,7 @@ <h4>Tabview.insertView</h4> <b>insertView</b>(<i>win, tabWidget, index, fn=None, noName=""</i>) <p> - Protected method to add a view (i.e. window) + Protected method to add a view (i.e. window). </p><dl> <dt><i>win</i></dt> <dd>
--- a/Documentation/Source/eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -140,9 +140,6 @@ <dt><i>istring</i></dt> <dd> indentation string (string) -</dd><dt><i>indString</i></dt> -<dd> -string used for indentation (space or tab) (string) </dd> </dl><dl> <dt>Returns:</dt> @@ -206,7 +203,7 @@ </dd> </dl><a NAME="E5MessageBoxWizardDialog.on_rAboutQt_toggled" ID="E5MessageBoxWizardDialog.on_rAboutQt_toggled"></a> <h4>E5MessageBoxWizardDialog.on_rAboutQt_toggled</h4> -<b>on_rAboutQt_toggled</b>(<i>checked</i>) +<b>on_rAboutQt_toggled</b>(<i>on</i>) <p> Private slot to handle the toggled signal of the rAboutQt radio button. @@ -217,7 +214,7 @@ </dd> </dl><a NAME="E5MessageBoxWizardDialog.on_rAbout_toggled" ID="E5MessageBoxWizardDialog.on_rAbout_toggled"></a> <h4>E5MessageBoxWizardDialog.on_rAbout_toggled</h4> -<b>on_rAbout_toggled</b>(<i>checked</i>) +<b>on_rAbout_toggled</b>(<i>on</i>) <p> Private slot to handle the toggled signal of the rAbout radio button. @@ -228,7 +225,7 @@ </dd> </dl><a NAME="E5MessageBoxWizardDialog.on_rCritical_toggled" ID="E5MessageBoxWizardDialog.on_rCritical_toggled"></a> <h4>E5MessageBoxWizardDialog.on_rCritical_toggled</h4> -<b>on_rCritical_toggled</b>(<i>checked</i>) +<b>on_rCritical_toggled</b>(<i>on</i>) <p> Private slot to handle the toggled signal of the rCritical radio button. @@ -239,7 +236,7 @@ </dd> </dl><a NAME="E5MessageBoxWizardDialog.on_rInformation_toggled" ID="E5MessageBoxWizardDialog.on_rInformation_toggled"></a> <h4>E5MessageBoxWizardDialog.on_rInformation_toggled</h4> -<b>on_rInformation_toggled</b>(<i>checked</i>) +<b>on_rInformation_toggled</b>(<i>on</i>) <p> Private slot to handle the toggled signal of the rInformation radio button. @@ -250,7 +247,7 @@ </dd> </dl><a NAME="E5MessageBoxWizardDialog.on_rOkToClearData_toggled" ID="E5MessageBoxWizardDialog.on_rOkToClearData_toggled"></a> <h4>E5MessageBoxWizardDialog.on_rOkToClearData_toggled</h4> -<b>on_rOkToClearData_toggled</b>(<i>checked</i>) +<b>on_rOkToClearData_toggled</b>(<i>on</i>) <p> Private slot to handle the toggled signal of the rOkToClearData radio button. @@ -261,7 +258,7 @@ </dd> </dl><a NAME="E5MessageBoxWizardDialog.on_rQuestion_toggled" ID="E5MessageBoxWizardDialog.on_rQuestion_toggled"></a> <h4>E5MessageBoxWizardDialog.on_rQuestion_toggled</h4> -<b>on_rQuestion_toggled</b>(<i>checked</i>) +<b>on_rQuestion_toggled</b>(<i>on</i>) <p> Private slot to handle the toggled signal of the rQuestion radio button. @@ -272,7 +269,7 @@ </dd> </dl><a NAME="E5MessageBoxWizardDialog.on_rRetryAbort_toggled" ID="E5MessageBoxWizardDialog.on_rRetryAbort_toggled"></a> <h4>E5MessageBoxWizardDialog.on_rRetryAbort_toggled</h4> -<b>on_rRetryAbort_toggled</b>(<i>checked</i>) +<b>on_rRetryAbort_toggled</b>(<i>on</i>) <p> Private slot to handle the toggled signal of the rRetryAbort radio button. @@ -283,7 +280,7 @@ </dd> </dl><a NAME="E5MessageBoxWizardDialog.on_rStandard_toggled" ID="E5MessageBoxWizardDialog.on_rStandard_toggled"></a> <h4>E5MessageBoxWizardDialog.on_rStandard_toggled</h4> -<b>on_rStandard_toggled</b>(<i>checked</i>) +<b>on_rStandard_toggled</b>(<i>on</i>) <p> Private slot to handle the toggled signal of the rStandard radio button. @@ -294,7 +291,7 @@ </dd> </dl><a NAME="E5MessageBoxWizardDialog.on_rWarning_toggled" ID="E5MessageBoxWizardDialog.on_rWarning_toggled"></a> <h4>E5MessageBoxWizardDialog.on_rWarning_toggled</h4> -<b>on_rWarning_toggled</b>(<i>checked</i>) +<b>on_rWarning_toggled</b>(<i>on</i>) <p> Private slot to handle the toggled signal of the rWarning radio button. @@ -305,7 +302,7 @@ </dd> </dl><a NAME="E5MessageBoxWizardDialog.on_rYesNo_toggled" ID="E5MessageBoxWizardDialog.on_rYesNo_toggled"></a> <h4>E5MessageBoxWizardDialog.on_rYesNo_toggled</h4> -<b>on_rYesNo_toggled</b>(<i>checked</i>) +<b>on_rYesNo_toggled</b>(<i>on</i>) <p> Private slot to handle the toggled signal of the rYesNo radio button.
--- a/Documentation/Source/eric5.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -293,10 +293,13 @@ <p> Private method to send a command to the PyQt5 server. </p><dl> -<dt><i>commandDict</i></dt> +<dt><i>command</i></dt> <dd> dictionary with command string and related data (dict) +</dd><dt><i>kw=</i></dt> +<dd> +parameters for the command </dd> </dl><dl> <dt>Returns:</dt>
--- a/Documentation/Source/eric5.Preferences.ConfigurationDialog.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationDialog.html Sun Sep 29 18:23:27 2013 +0200 @@ -86,7 +86,7 @@ <td>Private slot to handle a change of the preferences.</td> </tr><tr> <td><a href="#ConfigurationDialog.accept">accept</a></td> -<td></td> +<td>Public method to accept the dialog.</td> </tr><tr> <td><a href="#ConfigurationDialog.getConfigurationPageName">getConfigurationPageName</a></td> <td>Public method to get the page name of the current page.</td> @@ -147,15 +147,17 @@ </p><a NAME="ConfigurationDialog.accept" ID="ConfigurationDialog.accept"></a> <h4>ConfigurationDialog.accept</h4> <b>accept</b>(<i></i>) -<a NAME="ConfigurationDialog.getConfigurationPageName" ID="ConfigurationDialog.getConfigurationPageName"></a> +<p> + Public method to accept the dialog. +</p><a NAME="ConfigurationDialog.getConfigurationPageName" ID="ConfigurationDialog.getConfigurationPageName"></a> <h4>ConfigurationDialog.getConfigurationPageName</h4> <b>getConfigurationPageName</b>(<i></i>) <p> Public method to get the page name of the current page. </p><dl> -<dt><i>page</i></dt> +<dt>Returns:</dt> <dd> -name of the current page (string) +page name of the current page (string) </dd> </dl><a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a> <h4>ConfigurationDialog.setPreferences</h4> @@ -347,6 +349,11 @@ mode of the configuration dialog (DefaultMode, HelpBrowserMode, TrayStarterMode) </dd> +</dl><dl> +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +raised to indicate an invalid dialog mode +</dd> </dl><a NAME="ConfigurationWidget.__filterChildItems" ID="ConfigurationWidget.__filterChildItems"></a> <h4>ConfigurationWidget.__filterChildItems</h4> <b>__filterChildItems</b>(<i>parent, filter</i>) @@ -449,9 +456,9 @@ <p> Public method to get the page name of the current page. </p><dl> -<dt><i>page</i></dt> +<dt>Returns:</dt> <dd> -name of the current page (string) +page name of the current page (string) </dd> </dl><a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a> <h4>ConfigurationWidget.getLexers</h4>
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.ApplicationPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.ApplicationPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -94,6 +94,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.CooperationPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.CooperationPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -132,6 +132,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.CorbaPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.CorbaPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -102,6 +102,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.DebuggerGeneralPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.DebuggerGeneralPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -134,6 +134,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.DebuggerPython3Page.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.DebuggerPython3Page.html Sun Sep 29 18:23:27 2013 +0200 @@ -110,6 +110,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.DebuggerPythonPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.DebuggerPythonPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -110,6 +110,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.DebuggerRubyPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.DebuggerRubyPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -102,6 +102,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorAPIsPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorAPIsPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -220,6 +220,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorAutocompletionPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorAutocompletionPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -94,6 +94,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorAutocompletionQScintillaPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorAutocompletionQScintillaPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -94,6 +94,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorCalltipsPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorCalltipsPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -94,6 +94,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorCalltipsQScintillaPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorCalltipsQScintillaPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -94,6 +94,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorExportersPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorExportersPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -115,6 +115,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorFilePage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorFilePage.html Sun Sep 29 18:23:27 2013 +0200 @@ -187,6 +187,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorGeneralPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorGeneralPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -107,6 +107,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorHighlightersPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorHighlightersPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -105,37 +105,47 @@ <h4>EditorHighlightersPage.on_deleteLexerButton_clicked</h4> <b>on_deleteLexerButton_clicked</b>(<i></i>) <p> - Private slot to delete the currently selected lexer association of the list. + Private slot to delete the currently selected lexer association of the + list. </p><a NAME="EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged" ID="EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged"></a> <h4>EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged</h4> <b>on_editorLexerCombo_currentIndexChanged</b>(<i>text</i>) <p> Private slot to handle the selection of a lexer. -</p><a NAME="EditorHighlightersPage.on_editorLexerList_itemActivated" ID="EditorHighlightersPage.on_editorLexerList_itemActivated"></a> +</p><dl> +<dt><i>text</i></dt> +<dd> +text of the lexer combo (string) +</dd> +</dl><a NAME="EditorHighlightersPage.on_editorLexerList_itemActivated" ID="EditorHighlightersPage.on_editorLexerList_itemActivated"></a> <h4>EditorHighlightersPage.on_editorLexerList_itemActivated</h4> <b>on_editorLexerList_itemActivated</b>(<i>itm, column</i>) <p> - Private slot to handle the activated signal of the lexer association list. + Private slot to handle the activated signal of the lexer association + list. </p><dl> <dt><i>itm</i></dt> <dd> reference to the selecte item (QTreeWidgetItem) </dd><dt><i>column</i></dt> <dd> -column the item was clicked or activated (integer) (ignored) +column the item was clicked or activated (integer) + (ignored) </dd> </dl><a NAME="EditorHighlightersPage.on_editorLexerList_itemClicked" ID="EditorHighlightersPage.on_editorLexerList_itemClicked"></a> <h4>EditorHighlightersPage.on_editorLexerList_itemClicked</h4> <b>on_editorLexerList_itemClicked</b>(<i>itm, column</i>) <p> - Private slot to handle the clicked signal of the lexer association list. + Private slot to handle the clicked signal of the lexer association + list. </p><dl> <dt><i>itm</i></dt> <dd> reference to the selecte item (QTreeWidgetItem) </dd><dt><i>column</i></dt> <dd> -column the item was clicked or activated (integer) (ignored) +column the item was clicked or activated (integer) + (ignored) </dd> </dl><a NAME="EditorHighlightersPage.save" ID="EditorHighlightersPage.save"></a> <h4>EditorHighlightersPage.save</h4> @@ -155,6 +165,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorHighlightingStylesPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorHighlightingStylesPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -373,6 +373,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorKeywordsPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorKeywordsPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -120,6 +120,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorPropertiesPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorPropertiesPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -99,6 +99,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorSearchPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorSearchPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -94,6 +94,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorSpellCheckingPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorSpellCheckingPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -110,6 +110,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorStylesPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorStylesPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -175,6 +175,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorSyntaxPage.html Sun Sep 29 18:22:08 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorSyntaxPage.html Sun Sep 29 18:23:27 2013 +0200 @@ -99,6 +99,11 @@ <dd> reference to the configuration dialog </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />