Mercurial Repositories > eric / changeset
changeset
Continued correcting doc strings by using the new doc string checker.
Sun, 29 Sep 2013 18:22:08 +0200
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Sun, 29 Sep 2013 18:22:08 +0200
- changeset 2965
- d133c7edd88a
- parent 2964
- 84b65fb9e780
- child 2966
- f85f686981ad
Continued correcting doc strings by using the new doc string checker.
--- a/Plugins/VcsPlugins/vcsPySvn/SvnLoginDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Plugins/VcsPlugins/vcsPySvn/SvnLoginDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -24,7 +24,7 @@ @param username username as supplied by subversion (string) @param may_save flag indicating, that subversion is willing to save the answers returned (boolean) - qparam parent reference to the parent widget (QWidget) + @param parent reference to the parent widget (QWidget) """ super().__init__(parent) self.setupUi(self)
--- a/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -135,7 +135,7 @@ """ Private method to send a command to the PyQt5 server. - @param commandDict dictionary with command string and related + @param command dictionary with command string and related data (dict) @keyparam kw parameters for the command @return flag indicating a successful transmission (boolean)
--- a/Preferences/__init__.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Preferences/__init__.py Sun Sep 29 18:22:08 2013 +0200 @@ -1227,7 +1227,7 @@ """ Module function to store the variables filter settings. - qparam filters variable filters to set + @param filters variable filters to set @param prefClass preferences class used as the storage area """ prefClass.settings.setValue("Variables/LocalsFilter", str(filters[0]))
--- a/Project/ProjectBaseBrowser.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Project/ProjectBaseBrowser.py Sun Sep 29 18:22:08 2013 +0200 @@ -25,7 +25,8 @@ class ProjectBaseBrowser(Browser): """ - Baseclass implementing common functionality for the various project browsers. + Baseclass implementing common functionality for the various project + browsers. @signal closeSourceWindow(str) emitted to close a source file """ @@ -36,7 +37,7 @@ Constructor @param project reference to the project object - @param type project browser type (string) + @param type_ project browser type (string) @param parent parent widget of this browser """ QTreeView.__init__(self, parent) @@ -522,26 +523,26 @@ def selectLocalEntries(self): """ - Public slot to handle the select local files context menu entries + Public slot to handle the select local files context menu entries. """ self._selectEntries(local=True, filter=[ProjectBrowserFileItem]) def selectVCSEntries(self): """ - Public slot to handle the select VCS files context menu entries + Public slot to handle the select VCS files context menu entries. """ self._selectEntries(local=False, filter=[ProjectBrowserFileItem]) def selectLocalDirEntries(self): """ - Public slot to handle the select local directories context menu entries + Public slot to handle the select local directories context menu entries. """ self._selectEntries(local=True, filter=[ProjectBrowserSimpleDirectoryItem, ProjectBrowserDirectoryItem]) def selectVCSDirEntries(self): """ - Public slot to handle the select VCS directories context menu entries + Public slot to handle the select VCS directories context menu entries. """ self._selectEntries(local=False, filter=[ProjectBrowserSimpleDirectoryItem, ProjectBrowserDirectoryItem]) @@ -630,7 +631,10 @@ def __checkHookKey(self, key): """ - Private method to check a hook key + Private method to check a hook key. + + @param key key of the hook to check (string) + @exception KeyError raised to indicate an invalid hook """ if len(self.hooks) == 0: raise KeyError("Hooks are not initialized.")
--- a/Project/ProjectBrowser.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Project/ProjectBrowser.py Sun Sep 29 18:22:08 2013 +0200 @@ -34,7 +34,6 @@ that doesn't fit these categories. Optionally it contains an additional tab with the file system browser. """ - def __init__(self, project, parent=None, embeddedBrowser=True): """ Constructor @@ -153,7 +152,7 @@ def __setBrowsersAvailable(self, browserFlags): """ - Private method to add selected browsers to the project browser + Private method to add selected browsers to the project browser. @param browserFlags flags indicating the browsers to add (integer) """ @@ -212,6 +211,8 @@ def __currentChanged(self, index): """ Private slot to handle the currentChanged(int) signal. + + @param index index of the tab (integer) """ if index > -1: browser = self.widget(index)
--- a/Project/ProjectFormsBrowser.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Project/ProjectFormsBrowser.py Sun Sep 29 18:22:08 2013 +0200 @@ -756,7 +756,7 @@ def __generateDialogCode(self): """ - Private method to generate dialog code for the form (Qt4 only) + Private method to generate dialog code for the form (Qt4 only). """ itm = self.model().item(self.currentIndex()) fn = itm.fileName()
--- a/Project/ProjectTranslationsBrowser.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Project/ProjectTranslationsBrowser.py Sun Sep 29 18:22:08 2013 +0200 @@ -1040,6 +1040,9 @@ def __releaseTSFileDone(self, exitCode, exitStatus): """ Private slot to handle the finished signal of the lrelease process. + + @param exitCode exit code of the process (integer) + @param exitStatus exit status of the process (QProcess.ExitStatus) """ self.lreleaseProcRunning = False if exitStatus == QProcess.NormalExit and exitCode == 0:
--- a/PyUnit/UnittestDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/PyUnit/UnittestDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -397,7 +397,7 @@ """ Private slot to handle the highlighted signal. - @param txt current text (string) + @param text current text (string) """ if text: for pattern in self.rxPatterns:
--- a/QScintilla/Editor.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Editor.py Sun Sep 29 18:22:08 2013 +0200 @@ -131,10 +131,12 @@ @param dbs reference to the debug server object @param fn name of the file to be opened (string). If it is None, a new (empty) editor is opened - @param vm reference to the view manager object (ViewManager.ViewManager) + @param vm reference to the view manager object + (ViewManager.ViewManager) @param filetype type of the source file (string) @param editor reference to an Editor object, if this is a cloned view @param tv reference to the task viewer object + @exception IOError raised to indicate an issue accessing the file """ super().__init__() self.setAttribute(Qt.WA_DeleteOnClose) @@ -469,7 +471,7 @@ """ Public method to add a clone to our list. - @param clone reference to the cloned editor (Editor) + @param editor reference to the cloned editor (Editor) """ self.__clones.append(editor) @@ -482,7 +484,7 @@ """ Public method to remove a clone from our list. - @param clone reference to the cloned editor (Editor) + @param editor reference to the cloned editor (Editor) """ if editor in self.__clones: editor.editorRenamed.disconnect(self.fileRenamed) @@ -495,7 +497,9 @@ """ Private method to generate a dummy filename for binding a lexer. - @param line0 first line of text to use in the generation process (string) + @param line0 first line of text to use in the generation process + (string) + @return dummy file name to be used for binding a lexer (string) """ bindName = "" line0 = line0.lower() @@ -574,7 +578,7 @@ def __initContextMenu(self): """ - Private method used to setup the context menu + Private method used to setup the context menu. """ self.miniMenu = Preferences.getEditor("MiniContextMenu") @@ -738,6 +742,8 @@ def __initContextMenuAutocompletion(self): """ Private method used to setup the Checks context sub menu. + + @return reference to the generated menu (QMenu) """ menu = QMenu(self.trUtf8('Autocomplete')) @@ -764,6 +770,8 @@ def __initContextMenuChecks(self): """ Private method used to setup the Checks context sub menu. + + @return reference to the generated menu (QMenu) """ menu = QMenu(self.trUtf8('Check')) menu.aboutToShow.connect(self.__showContextMenuChecks) @@ -772,6 +780,8 @@ def __initContextMenuShow(self): """ Private method used to setup the Show context sub menu. + + @return reference to the generated menu (QMenu) """ menu = QMenu(self.trUtf8('Show')) @@ -794,6 +804,8 @@ def __initContextMenuGraphics(self): """ Private method used to setup the diagrams context sub menu. + + @return reference to the generated menu (QMenu) """ menu = QMenu(self.trUtf8('Diagrams')) @@ -817,6 +829,8 @@ def __initContextMenuLanguages(self): """ Private method used to setup the Languages context sub menu. + + @return reference to the generated menu (QMenu) """ menu = QMenu(self.trUtf8("Languages")) @@ -858,6 +872,8 @@ def __initContextMenuEncodings(self): """ Private method used to setup the Encodings context sub menu. + + @return reference to the generated menu (QMenu) """ self.supportedEncodings = {} @@ -880,6 +896,8 @@ def __initContextMenuEol(self): """ Private method to setup the eol context sub menu. + + @return reference to the generated menu (QMenu) """ self.supportedEols = {} @@ -916,6 +934,8 @@ def __initContextMenuExporters(self): """ Private method used to setup the Exporters context sub menu. + + @return reference to the generated menu (QMenu) """ menu = QMenu(self.trUtf8("Export as")) @@ -932,7 +952,7 @@ def __initContextMenuMargins(self): """ - Private method used to setup the context menu for the margins + Private method used to setup the context menu for the margins. """ self.marginMenuActs = {} @@ -943,7 +963,7 @@ def __initContextMenuSeparateMargins(self): """ - Private method used to setup the context menu for the separated margins + Private method used to setup the context menu for the separated margins. """ # bookmark margin self.bmMarginMenu = QMenu() @@ -1040,7 +1060,7 @@ def __initContextMenuUnifiedMargins(self): """ - Private method used to setup the context menu for the unified margins + Private method used to setup the context menu for the unified margins. """ self.marginMenu = QMenu() @@ -1347,6 +1367,7 @@ """ Private slot to handle a change of the encoding. + @param encoding changed encoding (string) @keyparam propagate flag indicating to propagate the change (boolean) """ self.encoding = encoding @@ -1811,10 +1832,11 @@ def highlight(self, line=None, error=False, syntaxError=False): """ - Public method to highlight (or de-highlight) a particular line. + Public method to highlight [or de-highlight] a particular line. @param line line number to highlight (integer) - @param error flag indicating whether the error highlight should be used (boolean) + @param error flag indicating whether the error highlight should be + used (boolean) @param syntaxError flag indicating a syntax error (boolean) """ if line is None: @@ -1911,14 +1933,18 @@ """ Private slot to set changed breakpoints. - @param indexes indexes of changed breakpoints. + @param startIndex start index of the breakpoints being changed + (QModelIndex) + @param endIndex end index of the breakpoints being changed + (QModelIndex) """ if not self.inLinesChanged: self.__addBreakPoints(QModelIndex(), startIndex.row(), endIndex.row()) def __breakPointDataAboutToBeChanged(self, startIndex, endIndex): """ - Private slot to handle the dataAboutToBeChanged signal of the breakpoint model. + Private slot to handle the dataAboutToBeChanged signal of the + breakpoint model. @param startIndex start index of the rows to be changed (QModelIndex) @param endIndex end index of the rows to be changed (QModelIndex) @@ -2155,6 +2181,8 @@ def __clearBreakpoints(self, fileName): """ Private slot to clear all breakpoints. + + @param fileName name of the file (string) """ idxList = [] for handle, (ln, _, _, _, _) in list(self.breaks.items()): @@ -3572,7 +3600,7 @@ def indentLineOrSelection(self): """ - Public slot to indent the current line or current selection + Public slot to indent the current line or current selection. """ if self.hasSelectedText(): self.__indentSelection(True) @@ -3653,6 +3681,8 @@ def gotoMethodClass(self, goUp=False): """ Public method to go to the next Python method or class definition. + + @param goUp flag indicating the move direction (boolean) """ if self.isPy3File() or self.isPy2File() or self.isRubyFile(): lineNo = self.getCursorPosition()[0] @@ -5005,6 +5035,8 @@ def hasCoverageMarkers(self): """ Public method to test, if there are coverage markers. + + @return flag indicating the presence of coverage markers (boolean) """ return len(self.notcoveredMarkers) > 0 @@ -5638,6 +5670,7 @@ method. @param alsoDelete ignored + @return flag indicating a successful close of the editor (boolean) """ return self.vm.closeEditor(self) @@ -5764,7 +5797,6 @@ with the QWorkspace. @param evt the event, that was generated (QEvent) - @return flag indicating if the event could be processed (bool) """ if evt.type() == QEvent.WindowStateChange and \ self.fileName is not None: @@ -6004,6 +6036,8 @@ def __initContextMenuResources(self): """ Private method used to setup the Resources context sub menu. + + @return reference to the generated menu (QMenu) """ menu = QMenu(self.trUtf8('Resources')) @@ -6639,7 +6673,7 @@ def __processStartEditCommand(self, argsString): """ - Private slot to process a remote StartEdit command + Private slot to process a remote StartEdit command. @param argsString string containing the command parameters (string) """ @@ -6686,7 +6720,7 @@ def __processEndEditCommand(self, argsString): """ - Private slot to process a remote EndEdit command + Private slot to process a remote EndEdit command. @param argsString string containing the command parameters (string) """ @@ -6724,7 +6758,7 @@ def __processRequestSyncCommand(self, argsString): """ - Private slot to process a remote RequestSync command + Private slot to process a remote RequestSync command. @param argsString string containing the command parameters (string) """ @@ -6740,7 +6774,7 @@ def __processSyncCommand(self, argsString): """ - Private slot to process a remote Sync command + Private slot to process a remote Sync command. @param argsString string containing the command parameters (string) """
--- a/QScintilla/Exporters/ExporterBase.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Exporters/ExporterBase.py Sun Sep 29 18:22:08 2013 +0200 @@ -35,6 +35,7 @@ @param filter the filter string to be used (string). The filter for "All Files (*)" is appended by this method. + @return file name entered by the user (string) """ filter_ = filter filter_ += ";;" @@ -71,5 +72,8 @@ Public method performing the export. This method must be overridden by the real exporters. + + @exception NotImplementedError raised to indicate that this method + must be implemented by a subclass """ raise NotImplementedError
--- a/QScintilla/Exporters/ExporterPDF.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Exporters/ExporterPDF.py Sun Sep 29 18:22:08 2013 +0200 @@ -56,8 +56,9 @@ class PDFObjectTracker(object): """ - Class to conveniently handle the tracking of PDF objects - so that the cross-reference table can be built (PDF1.4Ref(p39)) + Class to conveniently handle the tracking of PDF objects so that the + cross-reference table can be built (PDF1.4Ref(p39)). + All writes to the file are passed through a PDFObjectTracker object. """ def __init__(self, file): @@ -155,6 +156,7 @@ """ Public method to convert the font size to points. + @param thousandths font size (integer) @return point size of the font (integer) """ return self.fontSize * thousandths / 1000.0
--- a/QScintilla/Exporters/ExporterTEX.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Exporters/ExporterTEX.py Sun Sep 29 18:22:08 2013 +0200 @@ -40,7 +40,7 @@ def __getTexRGB(self, color): """ - Private method to convert a color object to a TeX color string + Private method to convert a color object to a TeX color string. @param color color object to convert (QColor) @return TeX color string (string)
--- a/QScintilla/Lexers/Lexer.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/Lexer.py Sun Sep 29 18:22:08 2013 +0200 @@ -190,6 +190,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return True @@ -198,6 +199,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return True
--- a/QScintilla/Lexers/LexerBash.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerBash.py Sun Sep 29 18:22:08 2013 +0200 @@ -39,6 +39,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerBash.Comment] @@ -47,6 +48,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerBash.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerBatch.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerBatch.py Sun Sep 29 18:22:08 2013 +0200 @@ -31,6 +31,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerBatch.Comment] @@ -39,6 +40,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return False
--- a/QScintilla/Lexers/LexerCMake.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerCMake.py Sun Sep 29 18:22:08 2013 +0200 @@ -38,6 +38,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerCMake.Comment] @@ -46,6 +47,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerCMake.String]
--- a/QScintilla/Lexers/LexerCPP.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerCPP.py Sun Sep 29 18:22:08 2013 +0200 @@ -22,6 +22,8 @@ Constructor @param parent parent widget of this lexer + @param caseInsensitiveKeywords flag indicating keywords are case + insensitive (boolean) """ super().__init__(parent, caseInsensitiveKeywords) Lexer.__init__(self) @@ -82,6 +84,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerCPP.Comment, @@ -93,6 +96,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerCPP.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerCSS.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerCSS.py Sun Sep 29 18:22:08 2013 +0200 @@ -52,6 +52,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerCSS.Comment] @@ -60,6 +61,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerCSS.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerCSharp.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerCSharp.py Sun Sep 29 18:22:08 2013 +0200 @@ -56,6 +56,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerCSharp.Comment, @@ -67,6 +68,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerCSharp.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerD.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerD.py Sun Sep 29 18:22:08 2013 +0200 @@ -63,6 +63,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerD.Comment, @@ -75,6 +76,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerD.String,
--- a/QScintilla/Lexers/LexerDiff.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerDiff.py Sun Sep 29 18:22:08 2013 +0200 @@ -29,6 +29,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [LexerDiff.Comment] @@ -37,6 +38,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return False
--- a/QScintilla/Lexers/LexerFortran.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerFortran.py Sun Sep 29 18:22:08 2013 +0200 @@ -46,6 +46,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerFortran.Comment] @@ -54,6 +55,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerFortran.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerFortran77.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerFortran77.py Sun Sep 29 18:22:08 2013 +0200 @@ -46,6 +46,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerFortran77.Comment] @@ -54,6 +55,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerFortran77.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerHTML.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerHTML.py Sun Sep 29 18:22:08 2013 +0200 @@ -54,6 +54,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerHTML.HTMLComment, @@ -76,6 +77,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerHTML.HTMLDoubleQuotedString,
--- a/QScintilla/Lexers/LexerIDL.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerIDL.py Sun Sep 29 18:22:08 2013 +0200 @@ -56,6 +56,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerIDL.Comment, @@ -67,6 +68,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerIDL.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerJava.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerJava.py Sun Sep 29 18:22:08 2013 +0200 @@ -56,6 +56,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerJava.Comment, @@ -67,6 +68,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerJava.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerJavaScript.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerJavaScript.py Sun Sep 29 18:22:08 2013 +0200 @@ -56,6 +56,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerJavaScript.Comment, @@ -67,6 +68,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerJavaScript.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerLua.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerLua.py Sun Sep 29 18:22:08 2013 +0200 @@ -50,6 +50,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerLua.Comment, @@ -59,6 +60,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerLua.String,
--- a/QScintilla/Lexers/LexerMakefile.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerMakefile.py Sun Sep 29 18:22:08 2013 +0200 @@ -32,6 +32,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerMakefile.Comment] @@ -40,6 +41,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return False
--- a/QScintilla/Lexers/LexerMatlab.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerMatlab.py Sun Sep 29 18:22:08 2013 +0200 @@ -31,6 +31,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerMatlab.Comment] @@ -39,6 +40,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerMatlab.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerOctave.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerOctave.py Sun Sep 29 18:22:08 2013 +0200 @@ -31,6 +31,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerOctave.Comment] @@ -39,6 +40,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerOctave.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerPOV.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerPOV.py Sun Sep 29 18:22:08 2013 +0200 @@ -49,6 +49,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerPOV.Comment, @@ -58,6 +59,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerPOV.String,
--- a/QScintilla/Lexers/LexerPascal.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerPascal.py Sun Sep 29 18:22:08 2013 +0200 @@ -56,6 +56,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ try: @@ -71,6 +72,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerPascal.SingleQuotedString]
--- a/QScintilla/Lexers/LexerPerl.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerPerl.py Sun Sep 29 18:22:08 2013 +0200 @@ -56,6 +56,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerPerl.Comment] @@ -64,6 +65,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerPerl.DoubleQuotedHereDocument,
--- a/QScintilla/Lexers/LexerPostScript.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerPostScript.py Sun Sep 29 18:22:08 2013 +0200 @@ -41,6 +41,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerPostScript.Comment] @@ -49,6 +50,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return False
--- a/QScintilla/Lexers/LexerProperties.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerProperties.py Sun Sep 29 18:22:08 2013 +0200 @@ -42,6 +42,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerProperties.Comment] @@ -50,6 +51,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return False
--- a/QScintilla/Lexers/LexerPygments.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerPygments.py Sun Sep 29 18:22:08 2013 +0200 @@ -455,6 +455,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [PYGMENTS_COMMENT] @@ -463,6 +464,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [PYGMENTS_STRING, PYGMENTS_DOCSTRING, PYGMENTS_OTHER,
--- a/QScintilla/Lexers/LexerPython.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerPython.py Sun Sep 29 18:22:08 2013 +0200 @@ -35,6 +35,8 @@ def language(self): """ Public method to get the lexer language. + + @return lexer language (string) """ if not self.variant: return QsciLexerPython.language(self) @@ -123,6 +125,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerPython.Comment, @@ -132,6 +135,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerPython.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerRuby.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerRuby.py Sun Sep 29 18:22:08 2013 +0200 @@ -50,6 +50,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerRuby.Comment] @@ -58,6 +59,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerRuby.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerSQL.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerSQL.py Sun Sep 29 18:22:08 2013 +0200 @@ -48,6 +48,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerSQL.Comment, @@ -59,6 +60,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerSQL.DoubleQuotedString,
--- a/QScintilla/Lexers/LexerTCL.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerTCL.py Sun Sep 29 18:22:08 2013 +0200 @@ -46,6 +46,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerTCL.Comment, @@ -57,6 +58,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerTCL.QuotedString]
--- a/QScintilla/Lexers/LexerTeX.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerTeX.py Sun Sep 29 18:22:08 2013 +0200 @@ -44,6 +44,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return False @@ -52,6 +53,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerTeX.Text]
--- a/QScintilla/Lexers/LexerVHDL.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerVHDL.py Sun Sep 29 18:22:08 2013 +0200 @@ -43,6 +43,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerVHDL.Comment, @@ -52,6 +53,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerVHDL.String,
--- a/QScintilla/Lexers/LexerXML.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerXML.py Sun Sep 29 18:22:08 2013 +0200 @@ -50,6 +50,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerXML.HTMLComment, @@ -72,6 +73,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return style in [QsciLexerXML.HTMLDoubleQuotedString,
--- a/QScintilla/Lexers/LexerYAML.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Lexers/LexerYAML.py Sun Sep 29 18:22:08 2013 +0200 @@ -38,6 +38,7 @@ """ Public method to check, if a style is a comment style. + @param style style to check (integer) @return flag indicating a comment style (boolean) """ return style in [QsciLexerYAML.Comment] @@ -46,6 +47,7 @@ """ Public method to check, if a style is a string style. + @param style style to check (integer) @return flag indicating a string style (boolean) """ return False
--- a/QScintilla/MiniEditor.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/MiniEditor.py Sun Sep 29 18:22:08 2013 +0200 @@ -41,8 +41,6 @@ Constructor @param parent parent widget (QWidget) - @param name name of this instance (string) - @param flags window flags """ super().__init__(parent) @@ -218,6 +216,8 @@ def __save(self): """ Private slot to save a file. + + @return flag indicating success (boolean) """ if not self.__curFile: return self.__saveAs() @@ -227,6 +227,8 @@ def __saveAs(self): """ Private slot to save a file with a new name. + + @return flag indicating success (boolean) """ fileName = E5FileDialog.getSaveFileName(self) if not fileName: @@ -309,7 +311,6 @@ @param act reference to the action object (E5Action) @param category category the action belongs to (string) - @param prefClass preferences class used as the storage area """ if act.objectName(): accel = Preferences.Prefs.settings.value( @@ -2315,7 +2316,7 @@ def __initContextMenu(self): """ - Private method used to setup the context menu + Private method used to setup the context menu. """ self.contextMenu = QMenu() @@ -2339,6 +2340,8 @@ def __initContextMenuLanguages(self): """ Private method used to setup the Languages context sub menu. + + @return reference to the generated menu (QMenu) """ menu = QMenu(self.trUtf8("Languages")) @@ -2585,7 +2588,9 @@ """ Private method to generate a dummy filename for binding a lexer. - @param line0 first line of text to use in the generation process (string) + @param line0 first line of text to use in the generation process + (string) + @return dummy file name to be used for binding a lexer (string) """ bindName = self.__curFile line0 = line0.lower()
--- a/QScintilla/QsciScintillaCompat.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/QsciScintillaCompat.py Sun Sep 29 18:22:08 2013 +0200 @@ -55,8 +55,6 @@ Constructor @param parent parent widget (QWidget) - @param name name of this instance (string) - @param flags window flags """ super().__init__(parent) @@ -181,6 +179,8 @@ def getEndStyled(self): """ Public method to get the last styled position. + + @return end position of the last styling run (integer) """ return self.SendScintilla(QsciScintilla.SCI_GETENDSTYLED) @@ -535,8 +535,10 @@ def getSelectionN(self, index): """ - Public method to get the start and end of a selection given by its index. + Public method to get the start and end of a selection given by its + index. + @param index index of the selection (integer) @return tuple with start line and index and end line and index (tuple of four int) for the given selection """ @@ -888,7 +890,6 @@ QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) @param spos position of the indicator start (integer) @param length length of the indicator (integer) - @exception ValueError the indicator or style are not valid """ self.setCurrentIndicator(indicator) self.SendScintilla(QsciScintilla.SCI_INDICATORFILLRANGE, spos, length) @@ -903,7 +904,6 @@ @param sindex index of the indicator start (integer) @param eline line number of the indicator end (integer) @param eindex index of the indicator end (integer) - @exception ValueError the indicator or style are not valid """ spos = self.positionFromLineIndex(sline, sindex) epos = self.positionFromLineIndex(eline, eindex) @@ -1096,10 +1096,11 @@ """ Protected method to handle events. - Note: We are not interested in the standard QsciScintilla event handling - because we do it our self. + Note: We are not interested in the standard QsciScintilla event + handling because we do it our self. @param evt event object to handle (QEvent) + @return result of the event handling (boolean) """ return QsciScintillaBase.event(self, evt)
--- a/QScintilla/SearchReplaceWidget.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/SearchReplaceWidget.py Sun Sep 29 18:22:08 2013 +0200 @@ -174,6 +174,8 @@ def on_findtextCombo_editTextChanged(self, txt): """ Private slot to enable/disable the find buttons. + + @param txt text of the find text combo (string) """ if not txt: self.ui.findNextButton.setEnabled(False)
--- a/QScintilla/Shell.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/Shell.py Sun Sep 29 18:22:08 2013 +0200 @@ -884,6 +884,8 @@ def __isCursorOnLastLine(self): """ Private method to check, if the cursor is on the last line. + + @return flag indicating that the cursor is on the last line (boolean) """ cline, ccol = self.getCursorPosition() return cline == self.lines() - 1
--- a/QScintilla/SpellChecker.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/SpellChecker.py Sun Sep 29 18:22:08 2013 +0200 @@ -358,7 +358,7 @@ def checkDocument(self): """ - Public method to check the complete document + Public method to check the complete document. """ self.__checkDocumentPart(0, self.editor.length()) @@ -489,6 +489,8 @@ def __iter__(self): """ Private method to create an iterator. + + @return self """ return self @@ -497,6 +499,7 @@ Public method to advance to the next error. @return self + @exception StopIteration raised to indicate the end of the iteration """ spell = self._spelling_dict if spell:
--- a/QScintilla/SpellCheckingDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/SpellCheckingDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -22,6 +22,11 @@ def __init__(self, spellChecker, startPos, endPos, parent=None): """ Constructor + + @param spellChecker reference to the spell checker (SpellChecker) + @param startPos position to start spell checking (integer) + @param endPos end position for spell checking (integer) + @param parent reference to the parent widget (QWidget) """ super().__init__(parent) self.setupUi(self) @@ -36,6 +41,8 @@ def __enableButtons(self, enable): """ Private method to set the buttons enabled state. + + @param enable enable state (boolean) """ self.addButton.setEnabled(enable) self.ignoreButton.setEnabled(enable)
--- a/QScintilla/TypingCompleters/CompleterBase.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/TypingCompleters/CompleterBase.py Sun Sep 29 18:22:08 2013 +0200 @@ -38,7 +38,7 @@ """ Public slot to set the enabled state. - @param enabled flag indicating the new state (boolean) + @param enable flag indicating the new enabled state (boolean) """ if enable: if not self.enabled: @@ -51,6 +51,8 @@ def isEnabled(self): """ Public method to get the enabled state. + + @return enabled state (boolean) """ return self.enabled
--- a/QScintilla/TypingCompleters/CompleterPython.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/TypingCompleters/CompleterPython.py Sun Sep 29 18:22:08 2013 +0200 @@ -401,7 +401,7 @@ def __inComment(self, line, col): """ - Private method to check, if the cursor is inside a comment + Private method to check, if the cursor is inside a comment. @param line current line (integer) @param col current position within line (integer)
--- a/QScintilla/TypingCompleters/CompleterRuby.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/TypingCompleters/CompleterRuby.py Sun Sep 29 18:22:08 2013 +0200 @@ -157,7 +157,7 @@ def __inComment(self, line, col): """ - Private method to check, if the cursor is inside a comment + Private method to check, if the cursor is inside a comment. @param line current line (integer) @param col current position within line (integer)
--- a/QScintilla/ZoomDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/QScintilla/ZoomDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -23,6 +23,7 @@ @param zoom zoom factor to show in the spinbox @param parent parent widget of this dialog (QWidget) @param name name of this dialog (string) + @param modal modal dialog state (boolean) """ super().__init__(parent) if name:
--- a/SqlBrowser/SqlBrowser.py Sun Sep 29 15:54:10 2013 +0200 +++ b/SqlBrowser/SqlBrowser.py Sun Sep 29 18:22:08 2013 +0200 @@ -30,7 +30,7 @@ Constructor @param connections list of database connections to add (list of strings) - @param reference to the parent widget (QWidget) + @param parent reference to the parent widget (QWidget) """ super().__init__(parent) self.setObjectName("SqlBrowser")
--- a/SqlBrowser/SqlBrowserWidget.py Sun Sep 29 15:54:10 2013 +0200 +++ b/SqlBrowser/SqlBrowserWidget.py Sun Sep 29 18:22:08 2013 +0200 @@ -120,6 +120,7 @@ @param password password (string) @param host host name (string) @param port port number (integer) + @return SQL error object (QSqlError) """ err = QSqlError()
--- a/SqlBrowser/SqlConnectionDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/SqlBrowser/SqlConnectionDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -26,6 +26,8 @@ def __init__(self, parent=None): """ Constructor + + @param parent reference to the parent widget (QWidget) """ super().__init__(parent) self.setupUi(self) @@ -73,13 +75,17 @@ def on_driverCombo_activated(self, txt): """ Private slot handling the selection of a database driver. + + @param txt text of the driver combo (string) """ self.__updateDialog() @pyqtSlot(str) - def on_databaseEdit_textChanged(self, p0): + def on_databaseEdit_textChanged(self, txt): """ Private slot handling the change of the database name. + + @param txt text of the edit (string) """ self.__updateDialog() @@ -102,9 +108,9 @@ """ Public method to retrieve the connection data. - @return tuple giving the driver name (string), the database name (string), - the user name (string), the password (string), the host name (string) - and the port (integer) + @return tuple giving the driver name (string), the database name + (string), the user name (string), the password (string), the + host name (string) and the port (integer) """ return ( self.driverCombo.currentText(),
--- a/Tasks/Task.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Tasks/Task.py Sun Sep 29 18:22:08 2013 +0200 @@ -33,15 +33,14 @@ """ Constructor - @param parent parent widget of the task (QWidget) @param summary summary text of the task (string) @param priority priority of the task (0=high, 1=normal, 2=low) @param filename filename containing the task (string) @param lineno line number containing the task (integer) @param completed flag indicating completion status (boolean) @param _time creation time of the task (float, if 0 use current time) - @param isProjectTask flag indicating a task related to the current project - (boolean) + @param isProjectTask flag indicating a task related to the current + project (boolean) @param taskType type of the task (one of TypeFixme, TypeTodo, TypeWarning, TypeNote) @param project reference to the project object (Project)
--- a/Tasks/TaskViewer.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Tasks/TaskViewer.py Sun Sep 29 18:22:08 2013 +0200 @@ -347,7 +347,7 @@ def __editTaskProperties(self): """ - Private slot to handle the "Properties" context menu entry + Private slot to handle the "Properties" context menu entry. """ from .TaskPropertiesDialog import TaskPropertiesDialog task = self.currentItem()
--- a/Templates/TemplateViewer.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Templates/TemplateViewer.py Sun Sep 29 18:22:08 2013 +0200 @@ -304,6 +304,7 @@ @param var template variable name (string) @param val value of the template variable (string) @param txt template text (string) + @return expanded and formatted variable (string) """ t = "" for line in txt.splitlines(): @@ -929,7 +930,7 @@ def readTemplates(self, filename=None): """ - Public method to read in the templates file (.e4c) + Public method to read in the templates file (.e4c). @param filename name of a templates file to read (string) """
--- a/Toolbox/SingleApplication.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Toolbox/SingleApplication.py Sun Sep 29 18:22:08 2013 +0200 @@ -93,6 +93,8 @@ @param cmd commandstring (string) @param params parameterstring (string) + @exception RuntimeError raised to indicate that this method must be + implemented by a subclass """ raise RuntimeError("'handleCommand' must be overridden") @@ -146,6 +148,8 @@ <b>Note</b>: This method must be overridden by subclasses. @param args command line args (list of strings) + @exception RuntimeError raised to indicate that this method must be + implemented by a subclass """ raise RuntimeError("'processArgs' must be overridden")
--- a/Toolbox/Startup.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Toolbox/Startup.py Sun Sep 29 18:22:08 2013 +0200 @@ -4,7 +4,7 @@ # """ -Module implementing some startup helper funcions +Module implementing some startup helper funcions. """ import os @@ -94,7 +94,8 @@ @param dirs Searchpath for the translations. (list of strings) @param tn The translation to be loaded. (string) - @return Tuple of a status flag and the loaded translator. (int, QTranslator) + @return Tuple of a status flag and the loaded translator + (int, QTranslator) """ trans = QTranslator(None) for dir in dirs: @@ -187,7 +188,8 @@ def simpleAppStartup(argv, appinfo, mwFactory, quitOnLastWindowClosed=True, app=None, raiseIt=True, installErrorHandler=False): """ - Module function to start up an application that doesn't need a specialized start up. + Module function to start up an application that doesn't need a specialized + start up. This function is used by all of eric5's helper programs. @@ -202,9 +204,11 @@ @keyparam quitOnLastWindowClosed flag indicating to quit the application, if the last window was closed (boolean) @keyparam app reference to the application object (QApplication or None) - @keyparam raiseIt flag indicating to raise the generated application window (boolean) + @keyparam raiseIt flag indicating to raise the generated application + window (boolean) @keyparam installErrorHandler flag indicating to install an error handler dialog (boolean) + @return exit result (integer) """ handleArgs(argv, appinfo) if app is None:
--- a/Tools/TRPreviewer.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Tools/TRPreviewer.py Sun Sep 29 18:22:08 2013 +0200 @@ -402,7 +402,7 @@ class Translation(object): """ - Class to store the properties of a translation + Class to store the properties of a translation. """ def __init__(self): """ @@ -778,8 +778,8 @@ """ Protected method called to filter an event. - @param object object, that generated the event (QObject) - @param event the event, that was generated by object (QEvent) + @param obj object, that generated the event (QObject) + @param ev the event, that was generated by object (QEvent) @return flag indicating if event was filtered out """ if obj in self.widgets and ev.type() == QEvent.Close:
--- a/Tools/UIPreviewer.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Tools/UIPreviewer.py Sun Sep 29 18:22:08 2013 +0200 @@ -401,8 +401,8 @@ """ Protected method called to filter an event. - @param object object, that generated the event (QObject) - @param event the event, that was generated by object (QEvent) + @param obj object, that generated the event (QObject) + @param ev the event, that was generated by object (QEvent) @return flag indicating if event was filtered out """ if obj == self.mainWidget:
--- a/UI/AuthenticationDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/AuthenticationDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -16,7 +16,8 @@ """ Class implementing the authentication dialog for the help browser. """ - def __init__(self, info, username, showSave=False, saveIt=False, parent=None): + def __init__(self, info, username, showSave=False, saveIt=False, + parent=None): """ Constructor @@ -24,6 +25,7 @@ @param username username as supplied by subversion (string) @param showSave flag to indicate to show the save checkbox (boolean) @param saveIt flag indicating the value for the save checkbox (boolean) + @param parent reference to the parent widget (QWidget) """ super().__init__(parent) self.setupUi(self) @@ -35,7 +37,8 @@ self.iconLabel.setText("") self.iconLabel.setPixmap( - self.style().standardIcon(QStyle.SP_MessageBoxQuestion).pixmap(32, 32)) + self.style().standardIcon(QStyle.SP_MessageBoxQuestion).pixmap( + 32, 32)) def setData(self, username, password): """
--- a/UI/Browser.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/Browser.py Sun Sep 29 18:22:08 2013 +0200 @@ -350,6 +350,8 @@ def _gotoAttribute(self, act): """ Protected slot to handle the selection of the goto menu. + + @param act reference to the action (E5Action) """ fileName, lineno = act.data() self.sourceFile[str, int].emit(fileName, lineno) @@ -517,6 +519,8 @@ def handleProgramChange(self, fn): """ Public slot to handle the programChange signal. + + @param fn file name (string) """ self.__model.programChange(os.path.dirname(fn))
--- a/UI/BrowserModel.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/BrowserModel.py Sun Sep 29 18:22:08 2013 +0200 @@ -728,7 +728,7 @@ Public method to get a child id. @param row number of child to get the id of (integer) - @param return reference to the child item (BrowserItem) + @return reference to the child item (BrowserItem) """ return self.childItems[row] @@ -761,7 +761,7 @@ Public method to get a specific data item. @param column number of the requested data item (integer) - @param return the stored data item + @return stored data item """ try: return self.itemData[column] @@ -1293,7 +1293,7 @@ """ Public method returning the line number defining this object. - return line number defining the object (integer) + @return line number defining the object (integer) """ return self._classObject.lineno @@ -1556,7 +1556,7 @@ """ Public method returning the line number defining this object. - return line number defining the object (integer) + @return line number defining the object (integer) """ return self._attributeObject.lineno @@ -1564,7 +1564,7 @@ """ Public method returning the line numbers this object is assigned to. - return line number the object is assigned to (list of integers) + @return line number the object is assigned to (list of integers) """ return self._attributeObject.linenos[:]
--- a/UI/DeleteFilesConfirmationDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/DeleteFilesConfirmationDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -23,8 +23,6 @@ @param parent parent of this dialog (QWidget) @param caption window title for the dialog (string) @param message message to be shown (string) - @param okLabel label for the OK button (string) - @param cancelLabel label for the Cancel button (string) @param files list of filenames to be shown (list of strings) """ super().__init__(parent)
--- a/UI/DiffDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/DiffDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -108,7 +108,7 @@ def context_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n'): - """ + r""" Compare two sequences of lines; generate the delta as a context diff. Context diffs are a compact way of showing line changes and a few @@ -161,7 +161,6 @@ @param lineterm line termination string (string) @return a generator yielding lines of differences """ - started = False prefixmap = {'insert': '+ ', 'delete': '- ', 'replace': '! ', 'equal': ' '} for group in SequenceMatcher(None, a, b).get_grouped_opcodes(n): @@ -201,6 +200,8 @@ def __init__(self, parent=None): """ Constructor + + @param parent reference to the parent widget (QWidget) """ super().__init__(parent) self.setupUi(self)
--- a/UI/EmailDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/EmailDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -384,8 +384,6 @@ def on_message_textChanged(self): """ Private slot to handle the textChanged signal of the message edit. - - @param txt changed text (string) """ self.sendButton.setEnabled( self.subject.text() != "" and \
--- a/UI/FindFileDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/FindFileDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -49,6 +49,7 @@ Constructor @param project reference to the project object + @param replaceMode flag indicating the replace dialog mode (boolean) @param parent parent widget of this dialog (QWidget) """ super().__init__(parent)
--- a/UI/LogView.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/LogView.py Sun Sep 29 18:22:08 2013 +0200 @@ -182,6 +182,10 @@ def searchNext(self, txt, caseSensitive, wholeWord): """ Public method to search the next occurrence of the given text. + + @param txt text to search for (string) + @param caseSensitive flag indicating case sensitivity (boolean) + @param wholeWord flag indicating a search for the whole word (boolean) """ self.__lastSearch = (txt, caseSensitive, wholeWord) flags = QTextDocument.FindFlags() @@ -195,6 +199,10 @@ def searchPrev(self, txt, caseSensitive, wholeWord): """ Public method to search the previous occurrence of the given text. + + @param txt text to search for (string) + @param caseSensitive flag indicating case sensitivity (boolean) + @param wholeWord flag indicating a search for the whole word (boolean) """ self.__lastSearch = (txt, caseSensitive, wholeWord) flags = QTextDocument.FindFlags(QTextDocument.FindBackward)
--- a/UI/NumbersWidget.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/NumbersWidget.py Sun Sep 29 18:22:08 2013 +0200 @@ -275,9 +275,11 @@ self.binTable.blockSignals(b) @pyqtSlot(int) - def on_sizeBox_valueChanged(self, index): + def on_sizeBox_valueChanged(self, value): """ - Slot documentation goes here. + Private slot handling a change of the bit size. + + @param value selected bit size (integer) """ self.__formatNumbers(10)
--- a/UI/PixmapCache.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/PixmapCache.py Sun Sep 29 18:22:08 2013 +0200 @@ -64,6 +64,7 @@ Module function to retrieve a pixmap. @param key name of the wanted pixmap (string) + @param cache reference to the pixmap cache object (PixmapCache) @return the requested pixmap (QPixmap) """ return cache.getPixmap(key) @@ -74,6 +75,7 @@ Module function to retrieve an icon. @param key name of the wanted icon (string) + @param cache reference to the pixmap cache object (PixmapCache) @return the requested icon (QIcon) """ return QIcon(cache.getPixmap(key)) @@ -84,6 +86,7 @@ Module function to retrieve a symbolic link icon. @param key name of the wanted icon (string) + @param cache reference to the pixmap cache object (PixmapCache) @return the requested icon (QIcon) """ pix1 = QPixmap(cache.getPixmap(key)) @@ -99,5 +102,6 @@ Module function to add a path to the search path. @param path path to add (string) + @param cache reference to the pixmap cache object (PixmapCache) """ cache.addSearchPath(path)
--- a/UI/Previewer.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/Previewer.py Sun Sep 29 18:22:08 2013 +0200 @@ -381,13 +381,16 @@ def __getHtml(self, language, text, ssiEnabled, filePath, rootPath): """ - Private method to process the given text depending upon the given language. + Private method to process the given text depending upon the given + language. @param language language of the text (string) @param text to be processed (string) - @param ssiEnabled flag indicating to do some (limited) SSI processing (boolean) + @param ssiEnabled flag indicating to do some (limited) SSI processing + (boolean) @param filePath file path of the text (string) @param rootPath root path to be used for SSI processing (str) + @return processed HTML text (string) """ if language == "HTML": if ssiEnabled:
--- a/UI/SearchWidget.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/SearchWidget.py Sun Sep 29 18:22:08 2013 +0200 @@ -31,6 +31,7 @@ """ Constructor + @param mainWindow reference to the main window (QWidget) @param parent reference to the parent widget (QWidget) @param spacer flag indicating to add a vertical spacer to the main layout (boolean)
--- a/UI/UserInterface.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UI/UserInterface.py Sun Sep 29 18:22:08 2013 +0200 @@ -49,7 +49,7 @@ class Redirector(QObject): """ - Helper class used to redirect stdout and stderr to the log window + Helper class used to redirect stdout and stderr to the log window. @signal appendStderr(str) emitted to write data to stderr logger @signal appendStdout(str) emitted to write data to stdout logger @@ -534,6 +534,7 @@ Private method to create the layout of the various windows. @param debugServer reference to the debug server object + @exception ValueError raised to indicate an invalid layout type """ # Create the view manager depending on the configuration setting logging.debug("Creating Viewmanager...") @@ -2823,9 +2824,9 @@ """ Public method to add actions to the list of actions. + @param actions list of actions to be added (list of E5Action) @param type string denoting the action set to get. It must be one of "ui" or "wizards". - @param actions list of actions to be added (list of E5Action) """ if type == 'ui': self.actions.extend(actions) @@ -2836,9 +2837,9 @@ """ Public method to remove actions from the list of actions. + @param actions list of actions (list of E5Action) @param type string denoting the action set to get. It must be one of "ui" or "wizards". - @param actions list of actions (list of E5Action) """ for act in actions: try: @@ -2871,6 +2872,7 @@ @param menuName name of the menu to search in (string) @param actionName object name of the action to search for (string) + @return reference to the menu action (QAction) """ try: menu = self.__menus[menuName] @@ -2888,6 +2890,7 @@ Public method to get a reference to an action of the main menu. @param menuName name of the menu to search in (string) + @return reference to the menu bar action (QAction) """ try: menu = self.__menus[menuName] @@ -5063,7 +5066,7 @@ def __readTasks(self): """ - Private slot to read in the tasks file (.e4t) + Private slot to read in the tasks file (.e4t). """ fn = os.path.join(Utilities.getConfigDir(), "eric5tasks.e4t") if not os.path.exists(fn): @@ -5098,7 +5101,7 @@ def __readSession(self): """ - Private slot to read in the session file (.e4s) + Private slot to read in the session file (.e4s). """ fn = os.path.join(Utilities.getConfigDir(), "eric5session.e4s") if not os.path.exists(fn): @@ -5400,7 +5403,7 @@ @param manual flag indicating an invocation via the menu (boolean) @param alternative index of server to download from (integer) - @keyparam showVersion flag indicating the show versions mode (boolean) + @keyparam showVersions flag indicating the show versions mode (boolean) """ if not manual: if Version.startswith("@@"):
--- a/Utilities/AutoSaver.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/AutoSaver.py Sun Sep 29 18:22:08 2013 +0200 @@ -23,6 +23,7 @@ @param parent reference to the parent object (QObject) @param save slot to be called to perform the save operation + @exception RuntimeError raised, if no parent is given """ super().__init__(parent)
--- a/Utilities/ClassBrowsers/__init__.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/ClassBrowsers/__init__.py Sun Sep 29 18:22:08 2013 +0200 @@ -38,16 +38,18 @@ def readmodule(module, path=[], isPyFile=False): - ''' - Read a source file and return a dictionary of classes, functions, modules, etc. . + """ + Read a source file and return a dictionary of classes, functions, modules, + etc. . - The real work of parsing the source file is delegated to the individual file - parsers. + The real work of parsing the source file is delegated to the individual + file parsers. @param module name of the source file (string) @param path path the file should be searched in (list of strings) + @param isPyFile flag indicating a Python file (boolean) @return the resulting dictionary - ''' + """ ext = os.path.splitext(module)[1].lower() if ext in __extensions["IDL"]: @@ -88,6 +90,7 @@ @param name filename or modulename to search for (string) @param path search path (list of strings) + @param isPyFile flag indicating a Python file (boolean) @return tuple of the open file, pathname and description. Description is a tuple of file suffix, file mode and file type) @exception ImportError The file or module wasn't found.
--- a/Utilities/ClassBrowsers/idlclbr.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/ClassBrowsers/idlclbr.py Sun Sep 29 18:22:08 2013 +0200 @@ -174,13 +174,13 @@ def readmodule_ex(module, path=[]): - ''' + """ Read a CORBA IDL file and return a dictionary of classes, functions and modules. @param module name of the CORBA IDL file (string) @param path path the file should be searched in (list of strings) @return the resulting dictionary - ''' + """ global _modules dict = {}
--- a/Utilities/ClassBrowsers/jsclbr.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/ClassBrowsers/jsclbr.py Sun Sep 29 18:22:08 2013 +0200 @@ -111,7 +111,10 @@ def __visit(self, root): """ - Private method implementing the visit logic delegating to interesting methods. + Private method implementing the visit logic delegating to interesting + methods. + + @param root root node to visit """ call = lambda n: getattr(self, "visit_{0}".format(n.type), self.visit_noop)(n) call(root) @@ -252,13 +255,13 @@ def readmodule_ex(module, path=[]): - ''' + """ Read a JavaScript file and return a dictionary of functions and variables. @param module name of the JavaScript file (string) @param path path the file should be searched in (list of strings) @return the resulting dictionary - ''' + """ global _modules dict = {}
--- a/Utilities/ClassBrowsers/pyclbr.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/ClassBrowsers/pyclbr.py Sun Sep 29 18:22:08 2013 +0200 @@ -205,7 +205,7 @@ def readmodule_ex(module, path=[], inpackage=False, isPyFile=False): - ''' + """ Read a module file and return a dictionary of classes. Search for MODULE in PATH and sys.path, read and parse the @@ -215,8 +215,9 @@ @param module name of the module file (string) @param path path the module should be searched in (list of strings) @param inpackage flag indicating a module inside a package is scanned + @param isPyFile flag indicating a Python file (boolean) @return the resulting dictionary - ''' + """ global _modules dict = {}
--- a/Utilities/ClassBrowsers/rbclbr.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/ClassBrowsers/rbclbr.py Sun Sep 29 18:22:08 2013 +0200 @@ -242,13 +242,13 @@ def readmodule_ex(module, path=[]): - ''' + """ Read a Ruby file and return a dictionary of classes, functions and modules. @param module name of the Ruby file (string) @param path path the file should be searched in (list of strings) @return the resulting dictionary - ''' + """ global _modules dict = {}
--- a/Utilities/FtpUtilities.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/FtpUtilities.py Sun Sep 29 18:22:08 2013 +0200 @@ -18,6 +18,7 @@ """ Exception class raised, if a parser issue was detected. """ + pass class FtpDirLineParser(QObject): @@ -153,10 +154,12 @@ def __splitUnixLine(self, line): """ - Split a line of a Unix like directory listing into meta data, - number of links, user, group, size, month, day, year or time - and name. + Private method to split a line of a Unix like directory listing. + + It splits the line into meta data, number of links, user, group, size, + month, day, year or time and name. + @param line directory line to split (string) @return tuple of nine strings giving the meta data, number of links, user, group, size, month, day, year or time and name @@ -192,8 +195,6 @@ @param line directory line to be parsed (string) @return URL info object containing the valid data (E5UrlInfo) - @exception FtpDirLineParserError Raised if the line is not of a - recognized Unix format. """ modeString, nlink, user, group, size, month, day, \ yearOrTime, name = self.__splitUnixLine(line) @@ -306,8 +307,6 @@ @param line directory line to be parsed (string) @return URL info object containing the valid data (E5UrlInfo) - @exception FtpDirLineParserError Raised if the line is not of a - recognized format. """ if self.__ignoreLine(line): return None
--- a/Utilities/ModuleParser.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/ModuleParser.py Sun Sep 29 18:22:08 2013 +0200 @@ -375,9 +375,9 @@ class Module(object): - ''' + """ Class to represent a Python module. - ''' + """ def __init__(self, name, file=None, type=None): """ Constructor @@ -1179,9 +1179,9 @@ class Class(VisibilityBase): - ''' + """ Class to represent a Python class. - ''' + """ def __init__(self, module, name, super, file, lineno): """ Constructor @@ -1282,9 +1282,9 @@ class RbModule(Class): - ''' + """ Class to represent a Ruby module. - ''' + """ def __init__(self, module, name, file, lineno): """ Constructor @@ -1308,9 +1308,9 @@ class Function(VisibilityBase): - ''' + """ Class to represent a Python function or method. - ''' + """ General = 0 Static = 1 Class = 2 @@ -1358,9 +1358,9 @@ class Attribute(VisibilityBase): - ''' + """ Class to represent a Python function or method. - ''' + """ def __init__(self, module, name, file, lineno, isSignal=False): """ Constructor @@ -1391,7 +1391,7 @@ def readModule(module, path=[], inpackage=False, basename="", extensions=None, caching=True): - ''' + """ Function to read a module file and parse it. The module is searched in path and sys.path, read and parsed. @@ -1410,7 +1410,7 @@ cached (boolean) @return reference to a Module object containing the parsed module information (Module) - ''' + """ global _modules if extensions is None:
--- a/Utilities/PasswordChecker.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/PasswordChecker.py Sun Sep 29 18:22:08 2013 +0200 @@ -4,7 +4,7 @@ # """ -Module implementing a checker for password strength +Module implementing a checker for password strength. """ import re
--- a/Utilities/__init__.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/__init__.py Sun Sep 29 18:22:08 2013 +0200 @@ -87,11 +87,14 @@ class CodingError(Exception): """ - Class implementing an exception, which is raised, if a given coding is incorrect. + Class implementing an exception, which is raised, if a given coding is + incorrect. """ def __init__(self, coding): """ Constructor + + @param coding coding to include in the message (string) """ self.errorMessage = QCoreApplication.translate("CodingError", "The coding '{0}' is wrong for the given text.").format(coding) @@ -266,6 +269,7 @@ @param text text to be encoded (string) @param orig_coding type of the original encoding (string) @return tuple of encoded text and encoding used (bytes, string) + @exception CodingError raised to indicate an invalid encoding """ encoding = None if orig_coding == 'utf-8-bom': @@ -692,6 +696,8 @@ @param path path to make relative (string) @param start path to make relative from (string) + @return relative path (string) + @exception ValueError raised to indicate an invalid path """ if not path: raise ValueError("no path specified") @@ -1191,7 +1197,7 @@ def getHomeDir(): """ - Function to get a users home directory + Function to get a users home directory. @return home directory (string) """ @@ -1532,7 +1538,6 @@ @return tuple of two flags indicating the presence of PySide for Python2 and PySide for Python3 (boolean, boolean) """ - try: # step 1: try Python3 variant of PySide import PySide # __IGNORE_EXCEPTION__ @@ -1680,7 +1685,8 @@ """ Function to provide an os.kill equivalent for Win32. - @param pid process id + @param pid process id (integer) + @return result of the kill (boolean) """ import win32api handle = win32api.OpenProcess(1, 0, pid)
--- a/Utilities/binplistlib.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/binplistlib.py Sun Sep 29 18:22:08 2013 +0200 @@ -106,6 +106,11 @@ This is used in keyed archiving. """ def __repr__(self): + """ + Public method to return an object representation. + + @return object representation (string) + """ return "Uid(%d)" % self @@ -186,7 +191,6 @@ @param data plist data (bytes) @return reference to the read object - @exception InvalidPlistException raised to signal an invalid plist file """ return readPlist(BytesIO(data)) @@ -196,7 +200,9 @@ Module function to write a plist bytes object. @param rootObject reference to the object to be written - @param binary flag indicating the generation of a binary plist bytes object (boolean) + @param binary flag indicating the generation of a binary plist bytes + object (boolean) + @return bytes object containing the plist data """ if not binary: return plistlib.writePlistToBytes(rootObject) @@ -269,6 +275,8 @@ Private method to read the root object. @return unpickled object + @exception InvalidPlistException raised to indicate an invalid + plist file """ result = None self.reset() @@ -311,6 +319,8 @@ Private method to read the object data. @return unpickled object + @exception InvalidPlistException raised to indicate an invalid + plist file """ result = None tmp_byte = self.contents[self.currentOffset:self.currentOffset + 1] @@ -402,6 +412,8 @@ @param length length of the object (integer) @return float object + @exception InvalidPlistException raised to indicate an invalid + plist file """ result = 0.0 to_read = pow(2, length) @@ -534,6 +546,9 @@ @param data data to extract the integer from (bytes) @param bytes length of the integer (integer) + @return read integer (integer) + @exception InvalidPlistException raised to indicate an invalid + plist file """ result = 0 # 1, 2, and 4 byte integers are unsigned @@ -555,9 +570,19 @@ Class wrapping a hashable value. """ def __init__(self, value): + """ + Constructor + + @param value object value + """ self.value = value def __repr__(self): + """ + Public method to generate a representation of the object. + + @return object representation (string) + """ return "<HashableWrapper: %s>" % [self.value] @@ -566,9 +591,19 @@ Class wrapping a boolean value. """ def __init__(self, value): + """ + Constructor + + @param value object value (boolean) + """ self.value = value def __repr__(self): + """ + Public method to generate a representation of the object. + + @return object representation (string) + """ return "<BoolWrapper: %s>" % self.value @@ -618,6 +653,7 @@ If the given object has been written already, return its position in the offset table. Otherwise, return None. + @param obj object @return position of the object (integer) """ return self.writtenReferences.get(obj) @@ -704,10 +740,25 @@ return root def incrementByteCount(self, field, incr=1): + """ + Public method to increment the byte count. + + @param field field to evaluate + @param incr byte count increment (integer) + """ self.byteCounts = self.byteCounts._replace( **{field: self.byteCounts.__getattribute__(field) + incr}) def computeOffsets(self, obj, asReference=False, isRoot=False): + """ + Public method to compute offsets of an object. + + @param obj plist object + @param asReference flag indicating offsets as references (boolean) + @param isRoot flag indicating a root object (boolean) + @exception InvalidPlistException raised to indicate an invalid + plist file + """ def check_key(key): if key is None: raise InvalidPlistException('Dictionary keys cannot be null in plists.') @@ -720,6 +771,7 @@ if size > 0b1110: size += self.intSize(size) return size + # If this should be a reference, then we keep a record of it in the # uniques table. if asReference: @@ -891,6 +943,8 @@ @param output current output (bytes) @return new output (bytes) + @exception InvalidPlistException raised to indicate an invalid + plist file """ all_positions = [] writtenReferences = list(self.writtenReferences.items()) @@ -923,6 +977,8 @@ @param obj integer to be packed @param bytes length the integer should be packed into (integer) @return serialized object (bytes) + @exception InvalidPlistException raised to indicate an invalid + plist file """ result = '' if bytes is None: @@ -947,6 +1003,8 @@ @param obj integer object @return number of bytes required (integer) + @exception InvalidPlistException raised to indicate an invalid + plist file """ # SIGNED if obj < 0: # Signed integer, always 8 bytes
--- a/Utilities/py3flakes/checker.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/py3flakes/checker.py Sun Sep 29 18:22:08 2013 +0200 @@ -42,6 +42,7 @@ ''' Created by the 'del' operator. ''' + pass class Importation(Binding): @@ -58,6 +59,7 @@ """ Represents binding a name as an argument. """ + pass class Assignment(Binding): @@ -68,6 +70,7 @@ the checker does not consider assignments in tuple/list unpacking to be Assignments, rather it treats them as simple Bindings. """ + pass class FunctionDefinition(Binding):
--- a/Utilities/py3flakes/messages.py Sun Sep 29 15:54:10 2013 +0200 +++ b/Utilities/py3flakes/messages.py Sun Sep 29 18:22:08 2013 +0200 @@ -7,6 +7,10 @@ # This module is based on pyflakes for Python2 but was heavily hacked to # work with Python3 and Qt (translatable messages) +""" +Module implementing the messages for py3flakes. +""" + from PyQt4.QtCore import QCoreApplication
--- a/UtilitiesPython2/Pep8Checker.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UtilitiesPython2/Pep8Checker.py Sun Sep 29 18:22:08 2013 +0200 @@ -45,6 +45,7 @@ @param code message code (string) @param check reference to the checker function (function) @param args arguments for the message (list) + @return error code (string) """ code = super(Pep8Report, self).error_args( line_number, offset, code, check, *args)
--- a/UtilitiesPython2/Pep8NamingCheckerPy2.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UtilitiesPython2/Pep8NamingCheckerPy2.py Sun Sep 29 18:22:08 2013 +0200 @@ -200,7 +200,7 @@ def __error(self, node, code): """ - Private method to build the error information + Private method to build the error information. @param node AST node to report an error for @param code error code to report (string) @@ -235,6 +235,7 @@ Private class to check the given node for a name to be avoided (N831). @param node AST note to check + @param parents list of parent nodes @return tuple giving line number, offset within line and error code (integer, integer, string) """ @@ -270,6 +271,7 @@ Classes for internal use have a leading underscore in addition. @param node AST note to check + @param parents list of parent nodes @return tuple giving line number, offset within line and error code (integer, integer, string) """ @@ -288,6 +290,7 @@ (e.g. threading.py), to retain backwards compatibility. @param node AST note to check + @param parents list of parent nodes @return tuple giving line number, offset within line and error code (integer, integer, string) """ @@ -307,6 +310,7 @@ first argument. A method should have 'self' as the first argument. @param node AST note to check + @param parents list of parent nodes @return tuple giving line number, offset within line and error code (integer, integer, string) """ @@ -351,6 +355,7 @@ Local variables in functions should be lowercase. @param node AST note to check + @param parents list of parent nodes @return tuple giving line number, offset within line and error code (integer, integer, string) """ @@ -376,6 +381,7 @@ Module and package names should be lowercase. @param node AST note to check + @param parents list of parent nodes @return tuple giving line number, offset within line and error code (integer, integer, string) """ @@ -397,6 +403,7 @@ naming convention (N811, N812, N813, N814). @param node AST note to check + @param parents list of parent nodes @return tuple giving line number, offset within line and error code (integer, integer, string) """
--- a/UtilitiesPython2/Tabnanny.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UtilitiesPython2/Tabnanny.py Sun Sep 29 18:22:08 2013 +0200 @@ -51,6 +51,8 @@ class NannyNag(Exception): """ + Class implementing an exception to indicate indentation issues. + Raised by tokeneater() if detecting an ambiguous indent. Captured and handled in check(). """ @@ -332,6 +334,7 @@ Function processing all tokens generated by a tokenizer run. @param tokens list of tokens + @exception NannyNag raised to indicate an indentation issue """ INDENT = tokenize.INDENT DEDENT = tokenize.DEDENT
--- a/UtilitiesPython2/__init__.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UtilitiesPython2/__init__.py Sun Sep 29 18:22:08 2013 +0200 @@ -4,5 +4,5 @@ # """ -This package implements some utilities and tools for Python2 +This package implements some utilities and tools for Python2. """
--- a/UtilitiesPython2/py2flakes/messages.py Sun Sep 29 15:54:10 2013 +0200 +++ b/UtilitiesPython2/py2flakes/messages.py Sun Sep 29 18:22:08 2013 +0200 @@ -7,6 +7,10 @@ # This module is based on pyflakes for Python2 but was heavily hacked to # work within eric5 +""" +Module implementing the messages for pyflakes. +""" + class Message(object): """ @@ -244,7 +248,7 @@ @param filename name of the file (string) @param lineno line number (integer) - @param name name of the unused variable (string) + @param names name of the unused variable (string) """ Message.__init__(self, filename, lineno) self.message_args = (names,)
--- a/VCS/ProjectBrowserHelper.py Sun Sep 29 15:54:10 2013 +0200 +++ b/VCS/ProjectBrowserHelper.py Sun Sep 29 18:22:08 2013 +0200 @@ -75,6 +75,8 @@ @param menu reference to the menu to be shown @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -88,6 +90,8 @@ @param menu reference to the menu to be shown @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -101,6 +105,8 @@ @param menu reference to the menu to be shown @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -114,6 +120,8 @@ @param menu reference to the menu to be shown @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented')
--- a/VCS/RepositoryInfoDialog.py Sun Sep 29 15:54:10 2013 +0200 +++ b/VCS/RepositoryInfoDialog.py Sun Sep 29 18:22:08 2013 +0200 @@ -17,6 +17,12 @@ Class implemting a dialog to show repository information. """ def __init__(self, parent, info): + """ + Constructor + + @param parent reference to the parent widget (QWidget) + @param info info data to show (string) + """ super().__init__(parent) self.setupUi(self) self.infoBrowser.setHtml(info)
--- a/VCS/StatusMonitorThread.py Sun Sep 29 15:54:10 2013 +0200 +++ b/VCS/StatusMonitorThread.py Sun Sep 29 18:22:08 2013 +0200 @@ -179,8 +179,10 @@ <li>" " path is back at normal</li> </ul> - @return tuple of flag indicating successful operation (boolean) and + @ireturn tuple of flag indicating successful operation (boolean) and a status message in case of non successful operation (string) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented')
--- a/VCS/VersionControl.py Sun Sep 29 15:54:10 2013 +0200 +++ b/VCS/VersionControl.py Sun Sep 29 18:22:08 2013 +0200 @@ -28,9 +28,10 @@ and the common methods. @signal vcsStatusMonitorData(list of str) emitted to update the VCS status - @signal vcsStatusMonitorStatus(str, str) emitted to signal the status of the - monitoring thread (ok, nok, op, off) and a status message - @signal vcsStatusChanged() emitted to indicate a change of the overall VCS status + @signal vcsStatusMonitorStatus(str, str) emitted to signal the status of + the monitoring thread (ok, nok, op, off) and a status message + @signal vcsStatusChanged() emitted to indicate a change of the overall + VCS status """ vcsStatusMonitorData = pyqtSignal(list) vcsStatusMonitorStatus = pyqtSignal(str, str) @@ -75,6 +76,9 @@ def vcsShutdown(self): """ Public method used to shutdown the vcs interface. + + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -82,10 +86,10 @@ """ Public method used to test for the presence of the vcs. - It must return a bool to indicate the existance and a string giving - an error message in case of failure. - - @exception RuntimeError not implemented + @ireturn tuple of flag indicating the existence and a string + giving an error message in case of failure + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -93,21 +97,23 @@ """ Public method used to initialize the vcs. - It must return a boolean to indicate an execution without errors. - @param vcsDir name of the VCS directory (string) @param noDialog flag indicating quiet operations (boolean) - @exception RuntimeError not implemented + @ireturn flag indicating success (boolean) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') def vcsConvertProject(self, vcsDataDict, project): """ - Public method to convert an uncontrolled project to a version controlled project. + Public method to convert an uncontrolled project to a version + controlled project. @param vcsDataDict dictionary of data required for the conversion @param project reference to the project object - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -118,9 +124,10 @@ @param vcsDataDict dictionary of data required for the import @param projectDir project directory (string) @param noDialog flag indicating quiet operations - @return flag indicating an execution without errors (boolean) + @ireturn flag indicating an execution without errors (boolean) and a flag indicating the version controll status (boolean) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -131,8 +138,9 @@ @param vcsDataDict dictionary of data required for the checkout @param projectDir project directory to create (string) @param noDialog flag indicating quiet operations - @return flag indicating an execution without errors (boolean) - @exception RuntimeError not implemented + @ireturn flag indicating an execution without errors (boolean) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -140,25 +148,25 @@ """ Public method used to export a directory from the vcs. - It must return a boolean to indicate an execution without errors. - @param vcsDataDict dictionary of data required for the export @param projectDir project directory to create (string) - @return flag indicating an execution without errors (boolean) - @exception RuntimeError not implemented + @ireturn flag indicating an execution without errors (boolean) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') def vcsCommit(self, name, message, noDialog=False): """ - Public method used to make the change of a file/directory permanent in the vcs. - - It must return a boolean to indicate an execution without errors. + Public method used to make the change of a file/directory permanent in + the vcs. @param name file/directory name to be committed (string) @param message message for this operation (string) - @param noDialog flag indicating quiet operations - @exception RuntimeError not implemented + @param noDialog flag indicating quiet operations (boolean) + @ireturn flag indicating success (boolean) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -166,13 +174,12 @@ """ Public method used to update a file/directory in the vcs. - It must not return anything. - @param name file/directory name to be updated (string) @param noDialog flag indicating quiet operations (boolean) - @return flag indicating, that the update contained an add + @ireturn flag indicating, that the update contained an add or delete (boolean) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -180,12 +187,11 @@ """ Public method used to add a file/directory in the vcs. - It must not return anything. - @param name file/directory name to be added (string) @param isDir flag indicating name is a directory (boolean) @param noDialog flag indicating quiet operations (boolean) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -193,11 +199,10 @@ """ Public method used to add a file/directory in binary mode in the vcs. - It must not return anything. - @param name file/directory name to be added (string) @param isDir flag indicating name is a directory (boolean) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -205,10 +210,9 @@ """ Public method to add a directory tree rooted at path in the vcs. - It must not return anything. - @param path root directory of the tree to be added (string) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -216,12 +220,12 @@ """ Public method used to add a file/directory in the vcs. - It must return a flag indicating successfull operation - @param name file/directory name to be removed (string) @param project flag indicating deletion of a project tree (boolean) @param noDialog flag indicating quiet operations - @exception RuntimeError not implemented + @ireturn flag indicating success (boolean) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -233,8 +237,9 @@ @param project reference to the project object @param target new name of the file/directory (string) @param noDialog flag indicating quiet operations - @return flag indicating successfull operation (boolean) - @exception RuntimeError not implemented + @ireturn flag indicating successfull operation (boolean) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -242,10 +247,9 @@ """ Public method used to view the log of a file/directory in the vcs. - It must not return anything. - @param name file/directory name to show the log for (string) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -253,10 +257,9 @@ """ Public method used to view the diff of a file/directory in the vcs. - It must not return anything. - @param name file/directory name to be diffed (string) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -264,10 +267,9 @@ """ Public method used to view the history of a file/directory in the vcs. - It must not return anything. - @param name file/directory name to show the history for (string) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -275,10 +277,9 @@ """ Public method used to view the status of a file/directory in the vcs. - It must not return anything. - @param name file/directory name to show the status for (string) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -286,10 +287,9 @@ """ Public method used to set the tag of a file/directory in the vcs. - It must not return anything. - @param name file/directory name to be tagged (string) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -297,10 +297,9 @@ """ Public method used to revert changes made to a file/directory. - It must not return anything. - @param name file/directory name to be reverted (string) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -308,12 +307,11 @@ """ Public method used to switch a directory to a different tag/branch. - It must not return anything. - @param name directory name to be switched (string) - @return flag indicating, that the switch contained an add + @ireturn flag indicating, that the switch contained an add or delete (boolean) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -321,10 +319,9 @@ """ Public method used to merge a tag/branch into the local project. - It must not return anything. - @param name file/directory name to be merged (string) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -333,21 +330,24 @@ Public method used to get the registered state of a file in the vcs. @param name filename to check (string) - @return a combination of canBeCommited and canBeAdded or + @ireturn a combination of canBeCommited and canBeAdded or 0 in order to signal an error - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') def vcsAllRegisteredStates(self, names, dname): """ - Public method used to get the registered states of a number of files in the vcs. + Public method used to get the registered states of a number of files + in the vcs. @param names dictionary with all filenames to be checked as keys @param dname directory to check in (string) - @return the received dictionary completed with a combination of + @ireturn the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -355,8 +355,9 @@ """ Public method returning the name of the vcs. - @return name of the vcs (string) - @exception RuntimeError not implemented + @ireturn name of the vcs (string) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -365,7 +366,8 @@ Public method used to cleanup the local copy. @param name directory name to be cleaned up (string) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -374,7 +376,8 @@ Public method used to execute arbitrary vcs commands. @param name directory name of the working directory (string) - @exception RuntimeError not implemented + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -384,16 +387,22 @@ @param project reference to the project object @param archive name of the project in the repository (string) - @param editable flag indicating that the project name is editable (boolean) + @param editable flag indicating that the project name is editable + (boolean) @param parent parent widget (QWidget) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') def vcsNewProjectOptionsDialog(self, parent=None): """ - 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. @param parent parent widget (QWidget) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -402,19 +411,25 @@ Public method to retrieve information about the repository. @param ppath local path to get the repository infos (string) - @return string with ready formated info for display (string) + @ireturn string with ready formated info for display (string) + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') - def vcsGetProjectBrowserHelper(self, browser, project, isTranslationsBrowser=False): + def vcsGetProjectBrowserHelper(self, browser, project, + isTranslationsBrowser=False): """ - Public method to instanciate a helper object for the different project browsers. + Public method to instanciate a helper object for the different + project browsers. @param browser reference to the project browser object @param project reference to the project object - @param isTranslationsBrowser flag indicating, the helper is requested for the - translations browser (this needs some special treatment) - @return the project browser helper object + @param isTranslationsBrowser flag indicating, the helper is requested + for the translations browser (this needs some special treatment) + @ireturn the project browser helper object + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -423,7 +438,9 @@ Public method to instanciate a helper object for the project. @param project reference to the project object - @return the project helper object + @ireturn the project helper object + @exception RuntimeError to indicate that this method must be + implemented by a subclass """ raise RuntimeError('Not implemented') @@ -455,7 +472,8 @@ @return a dictionary with the vcs operations as key and the respective options as values. The key 'global' must contain the global options. The other keys must be 'commit', 'update', - 'add', 'remove', 'diff', 'log', 'history', 'tag', 'status' and 'export'. + 'add', 'remove', 'diff', 'log', 'history', 'tag', 'status' and + 'export'. """ return self.defaultOptions @@ -525,9 +543,10 @@ ## below are some utility methods ##################################################################### - def startSynchronizedProcess(self, proc, program, arguments, workingDir=None): + def startSynchronizedProcess(self, proc, program, arguments, + workingDir=None): """ - Public method to start a synchroneous process + Public method to start a synchroneous process. This method starts a process and waits for its end while still serving the Qt event loop. @@ -546,7 +565,8 @@ proc.start(program, arguments) procStarted = proc.waitForStarted(5000) if not procStarted: - E5MessageBox.critical(None, + E5MessageBox.critical( + None, self.trUtf8('Process Generation Error'), self.trUtf8( 'The process {0} could not be started. ' @@ -558,7 +578,8 @@ QApplication.processEvents() QThread.msleep(300) QApplication.processEvents() - return (proc.exitStatus() == QProcess.NormalExit) and (proc.exitCode() == 0) + return (proc.exitStatus() == QProcess.NormalExit) and \ + (proc.exitCode() == 0) def splitPath(self, name): """ @@ -576,8 +597,8 @@ def splitPathList(self, names): """ - Public method splitting the list of names into a common directory part and - a file list. + Public method splitting the list of names into a common directory part + and a file list. @param names list of paths (list of strings) @return a tuple of string and list of strings (dirname, filenamelist) @@ -594,7 +615,8 @@ def addArguments(self, args, argslist): """ - Protected method to add an argument list to the already present arguments. + Protected method to add an argument list to the already present + arguments. @param args current arguments list (list of strings) @param argslist list of arguments (list of strings) @@ -603,9 +625,9 @@ if arg != '': args.append(arg) - ############################################################################ + ########################################################################### ## VCS status monitor thread related methods - ############################################################################ + ########################################################################### def __statusMonitorStatus(self, status, statusMsg): """ @@ -638,12 +660,14 @@ @return reference to the monitor thread (QThread) """ if project.pudata["VCSSTATUSMONITORINTERVAL"]: - vcsStatusMonitorInterval = project.pudata["VCSSTATUSMONITORINTERVAL"][0] + vcsStatusMonitorInterval = project.pudata[ + "VCSSTATUSMONITORINTERVAL"][0] else: - vcsStatusMonitorInterval = Preferences.getVCS("StatusMonitorInterval") + vcsStatusMonitorInterval = Preferences.getVCS( + "StatusMonitorInterval") if vcsStatusMonitorInterval > 0: - self.statusMonitorThread = \ - self._createStatusMonitorThread(vcsStatusMonitorInterval, project) + self.statusMonitorThread = self._createStatusMonitorThread( + vcsStatusMonitorInterval, project) if self.statusMonitorThread is not None: self.statusMonitorThread.vcsStatusMonitorData.connect( self.__statusMonitorData, Qt.QueuedConnection) @@ -672,7 +696,8 @@ self.statusMonitorThread.terminate() self.statusMonitorThread.wait(10000) self.statusMonitorThread = None - self.__statusMonitorStatus("off", + self.__statusMonitorStatus( + "off", self.trUtf8("Repository status checking is switched off")) def setStatusMonitorInterval(self, interval, project): @@ -741,12 +766,14 @@ def _createStatusMonitorThread(self, interval, project): """ - Protected method to create an instance of the VCS status monitor thread. + Protected method to create an instance of the VCS status monitor + thread. - Note: This method should be overwritten in subclasses in order to support - VCS status monitoring. + Note: This method should be overwritten in subclasses in order to + support VCS status monitoring. - @param interval check interval for the monitor thread in seconds (integer) + @param interval check interval for the monitor thread in seconds + (integer) @param project reference to the project object @return reference to the monitor thread (QThread) """
--- a/ViewManager/ViewManager.py Sun Sep 29 15:54:10 2013 +0200 +++ b/ViewManager/ViewManager.py Sun Sep 29 18:22:08 2013 +0200 @@ -267,7 +267,7 @@ """ Public method to signal if cascading of managed windows is available. - @return flag indicating cascading of windows is available + @ireturn flag indicating cascading of windows is available @exception RuntimeError Not implemented """ raise RuntimeError('Not implemented') @@ -276,7 +276,7 @@ """ Public method to signal if tiling of managed windows is available. - @return flag indicating tiling of windows is available + @ireturn flag indicating tiling of windows is available @exception RuntimeError Not implemented """ raise RuntimeError('Not implemented') @@ -301,14 +301,14 @@ """ Public method to return the active (i.e. current) window. - @return reference to the active editor + @ireturn reference to the active editor @exception RuntimeError Not implemented """ raise RuntimeError('Not implemented') def _removeAllViews(self): """ - Protected method to remove all views (i.e. windows) + Protected method to remove all views (i.e. windows). @exception RuntimeError Not implemented """ @@ -316,7 +316,7 @@ def _removeView(self, win): """ - Protected method to remove a view (i.e. window) + Protected method to remove a view (i.e. window). @param win editor window to be removed @exception RuntimeError Not implemented @@ -325,7 +325,7 @@ def _addView(self, win, fn=None, noName=""): """ - Protected method to add a view (i.e. window) + Protected method to add a view (i.e. window). @param win editor assembly to be added @param fn filename of this editor @@ -336,7 +336,7 @@ def _showView(self, win, fn=None): """ - Protected method to show a view (i.e. window) + Protected method to show a view (i.e. window). @param win editor assembly to be shown @param fn filename of this editor @@ -724,6 +724,8 @@ def __initContextMenuExporters(self): """ Private method used to setup the Exporters sub menu. + + @return reference to the generated menu (QMenu) """ menu = QMenu(QApplication.translate('ViewManager', "Export as")) @@ -2310,7 +2312,7 @@ def initEditMenu(self): """ - Public method to create the Edit menu + Public method to create the Edit menu. @return the generated menu """ @@ -2390,7 +2392,7 @@ def initEditToolbar(self, toolbarManager): """ - Public method to create the Edit toolbar + Public method to create the Edit toolbar. @param toolbarManager reference to a toolbar manager object (E5ToolBarManager) @return the generated toolbar @@ -2773,7 +2775,7 @@ def initSearchToolbars(self, toolbarManager): """ - Public method to create the Search toolbars + Public method to create the Search toolbars. @param toolbarManager reference to a toolbar manager object (E5ToolBarManager) @return a tuple of the generated toolbar (search, quicksearch) @@ -3098,7 +3100,7 @@ def initViewMenu(self): """ - Public method to create the View menu + Public method to create the View menu. @return the generated menu """ @@ -3123,7 +3125,7 @@ def initViewToolbar(self, toolbarManager): """ - Public method to create the View toolbar + Public method to create the View toolbar. @param toolbarManager reference to a toolbar manager object (E5ToolBarManager) @return the generated toolbar @@ -3234,7 +3236,7 @@ def initMacroMenu(self): """ - Public method to create the Macro menu + Public method to create the Macro menu. @return the generated menu """ @@ -3495,7 +3497,7 @@ def initBookmarkMenu(self): """ - Public method to create the Bookmark menu + Public method to create the Bookmark menu. @return the generated menu """ @@ -3535,7 +3537,7 @@ def initBookmarkToolbar(self, toolbarManager): """ - Public method to create the Bookmark toolbar + Public method to create the Bookmark toolbar. @param toolbarManager reference to a toolbar manager object (E5ToolBarManager) @return the generated toolbar @@ -3628,6 +3630,8 @@ def addToExtrasMenu(self, menu): """ Public method to add some actions to the extras menu. + + @param menu reference to the menu to add actions to (QMenu) """ self.__editSpellingMenu = QMenu(QApplication.translate('ViewManager', "Edit Dictionary")) @@ -3653,7 +3657,7 @@ def initSpellingToolbar(self, toolbarManager): """ - Public method to create the Spelling toolbar + Public method to create the Spelling toolbar. @param toolbarManager reference to a toolbar manager object (E5ToolBarManager) @return the generated toolbar @@ -3860,6 +3864,7 @@ @param filetype type of the source file (string) @param selStart start of an area to be selected (integer) @param selEnd end of an area to be selected (integer) + @param pos position within the line to place the cursor at (integer) """ try: newWin, editor = self.getEditor(fn, filetype=filetype) @@ -4602,7 +4607,7 @@ def __editSmartIndent(self): """ - Private method to handle the smart indent action + Private method to handle the smart indent action. """ self.activeWindow().smartIndentLineOrSelection() @@ -4694,6 +4699,9 @@ def __editorAutoCompletionAPIsAvailable(self, available): """ Private method to handle the availability of API autocompletion signal. + + @param available flag indicating the availability of API + autocompletion (boolean) """ self.autoCompleteFromAPIsAct.setEnabled(available) @@ -4709,11 +4717,11 @@ def textForFind(self, getCurrentWord=True): """ - Public method to determine the selection or the current word for the next - find operation. - - @param getCurrentWord flag indicating to return the current word, if no selected - text was found (boolean) + Public method to determine the selection or the current word for the + next find operation. + + @param getCurrentWord flag indicating to return the current word, if + no selected text was found (boolean) @return selection or current word (string) """ aw = self.activeWindow() @@ -4766,7 +4774,7 @@ def __quickSearchEnter(self): """ Private slot to handle the incremental quick search return pressed - (jump back to text) + (jump back to text). """ if self.quickFindtextCombo.lastActive: self.quickFindtextCombo.lastActive.setFocus() @@ -4777,7 +4785,7 @@ def __quickSearchEscape(self): """ Private slot to handle the incremental quick search escape pressed - (jump back to text) + (jump back to text). """ if self.quickFindtextCombo.lastActive: self.quickFindtextCombo.lastActive.setFocus() @@ -5137,6 +5145,9 @@ def __splitOrientation(self, checked): """ Private method to handle the split orientation action. + + @param checked flag indicating the checked state of the action + (boolean). True means splitting horizontally. """ if checked: self.setSplitOrientation(Qt.Horizontal) @@ -5497,6 +5508,8 @@ def __editSpellingDictionary(self, dictionaryFile): """ Private slot to edit the given spelling dictionary. + + @param dictionaryFile file name of the dictionary to edit (string) """ if os.path.exists(dictionaryFile): try: @@ -5999,6 +6012,7 @@ def getAPIsManager(self): """ Public method to get a reference to the APIs manager. + @return the APIs manager object (eric5.QScintilla.APIsManager) """ return self.apisManager
--- a/ViewManager/__init__.py Sun Sep 29 15:54:10 2013 +0200 +++ b/ViewManager/__init__.py Sun Sep 29 18:22:08 2013 +0200 @@ -35,6 +35,7 @@ @param dbs reference to the debug server object @param pluginManager reference to the plugin manager object @return the instantiated viewmanager + @exception RuntimeError raised if no view manager could be created """ viewManagerStr = Preferences.getViewManager() vm = pluginManager.getPluginObject("viewmanager", viewManagerStr)
--- a/eric5.e4p Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5.e4p Sun Sep 29 18:22:08 2013 +0200 @@ -1902,7 +1902,7 @@ <string>ExcludeFiles</string> </key> <value> - <string>*/ThirdParty/*, */coverage/*, */Ui_*.py, */Examples/*, */*_rc.py,*/pep8.py</string> + <string>*/ThirdParty/*, */coverage/*, */Ui_*.py, */Examples/*, */*_rc.py,*/pep8.py,*/py[23]flakes/checker.py</string> </value> <key> <string>ExcludeMessages</string>
--- a/eric5.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Python IDE +Eric5 Python IDE. This is the main Python script that performs the necessary initialization of the IDE and starts the Qt event loop.
--- a/eric5.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2005 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5 import main main()
--- a/eric5_api.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_api.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 API Generator +Eric5 API Generator. This is the main Python script of the API generator. It is this script that gets called via the API generation interface.
--- a/eric5_compare.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_compare.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Compare +Eric5 Compare. This is the main Python script that performs the necessary initialization of the Compare module and starts the Qt event loop. This is a standalone
--- a/eric5_compare.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_compare.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_compare import main main()
--- a/eric5_configure.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_configure.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Configure +Eric5 Configure. This is the main Python script to configure the eric5 IDE from the outside. """
--- a/eric5_configure.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_configure.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_configure import main main()
--- a/eric5_diff.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_diff.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Diff +Eric5 Diff. This is the main Python script that performs the necessary initialization of the Diff module and starts the Qt event loop. This is a standalone
--- a/eric5_diff.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_diff.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_diff import main main()
--- a/eric5_doc.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_doc.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Documentation Generator +Eric5 Documentation Generator. This is the main Python script of the documentation generator. It is this script that gets called via the source documentation interface. @@ -135,7 +135,6 @@ """ Main entry point into the application. """ - import getopt try:
--- a/eric5_editor.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_editor.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Editor +Eric5 Editor. This is the main Python script that performs the necessary initialization of the MiniEditor module and starts the Qt event loop. This is a standalone
--- a/eric5_editor.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_editor.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_editor import main main()
--- a/eric5_iconeditor.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_iconeditor.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Icon Editor +Eric5 Icon Editor. This is the main Python script that performs the necessary initialization of the icon editor and starts the Qt event loop. This is a standalone version
--- a/eric5_iconeditor.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_iconeditor.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_iconeditor import main main()
--- a/eric5_plugininstall.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_plugininstall.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Plugin Installer +Eric5 Plugin Installer. This is the main Python script to install eric5 plugins from outside of the IDE. """
--- a/eric5_plugininstall.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_plugininstall.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_plugininstall import main main()
--- a/eric5_pluginrepository.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_pluginrepository.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Plugin Installer +Eric5 Plugin Installer. This is the main Python script to install eric5 plugins from outside of the IDE. """
--- a/eric5_pluginrepository.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_pluginrepository.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_pluginrepository import main main()
--- a/eric5_pluginuninstall.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_pluginuninstall.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Plugin Uninstaller +Eric5 Plugin Uninstaller. This is the main Python script to uninstall eric5 plugins from outside of the IDE. """
--- a/eric5_pluginuninstall.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_pluginuninstall.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_pluginuninstall import main main()
--- a/eric5_qregexp.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_qregexp.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 QRegExp +Eric5 QRegExp. This is the main Python script that performs the necessary initialization of the QRegExp wizard module and starts the Qt event loop. This is a standalone
--- a/eric5_qregexp.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_qregexp.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_qregexp import main main()
--- a/eric5_qregularexpression.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_qregularexpression.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 QRegularExpression +Eric5 QRegularExpression. This is the main Python script that performs the necessary initialization of the QRegularExpression wizard module and starts the Qt event loop. This is a standalone
--- a/eric5_qregularexpression.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_qregularexpression.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_qregularexpression import main main()
--- a/eric5_re.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_re.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Re +Eric5 Re. This is the main Python script that performs the necessary initialization of the PyRegExp wizard module and starts the Qt event loop. This is a standalone
--- a/eric5_re.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_re.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_re import main main()
--- a/eric5_snap.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_snap.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Snap +Eric5 Snap. This is the main Python script that performs the necessary initialization of the snapshot module and starts the Qt event loop.
--- a/eric5_snap.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_snap.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2012 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_snap import main main()
--- a/eric5_sqlbrowser.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_sqlbrowser.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 SQL Browser +Eric5 SQL Browser. This is the main Python script that performs the necessary initialization of the SQL browser and starts the Qt event loop.
--- a/eric5_sqlbrowser.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_sqlbrowser.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_sqlbrowser import main main()
--- a/eric5_tray.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_tray.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Tray +Eric5 Tray. This is the main Python script that performs the necessary initialization of the system-tray application. This acts as a quickstarter by providing a
--- a/eric5_tray.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_tray.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_tray import main main()
--- a/eric5_trpreviewer.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_trpreviewer.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 TR Previewer +Eric5 TR Previewer. This is the main Python script that performs the necessary initialization of the tr previewer and starts the Qt event loop. This is a standalone version
--- a/eric5_trpreviewer.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_trpreviewer.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_trpreviewer import main main()
--- a/eric5_uipreviewer.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_uipreviewer.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 UI Previewer +Eric5 UI Previewer. This is the main Python script that performs the necessary initialization of the ui previewer and starts the Qt event loop. This is a standalone version
--- a/eric5_uipreviewer.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_uipreviewer.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_uipreviewer import main main()
--- a/eric5_unittest.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_unittest.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Unittest +Eric5 Unittest. This is the main Python script that performs the necessary initialization of the unittest module and starts the Qt event loop. This is a standalone
--- a/eric5_unittest.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_unittest.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_unittest import main main()
--- a/eric5_webbrowser.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_webbrowser.py Sun Sep 29 18:22:08 2013 +0200 @@ -5,7 +5,7 @@ # """ -Eric5 Web Browser +Eric5 Web Browser. This is the main Python script that performs the necessary initialization of the web browser and starts the Qt event loop. This is a standalone version
--- a/eric5_webbrowser.pyw Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5_webbrowser.pyw Sun Sep 29 18:22:08 2013 +0200 @@ -3,6 +3,10 @@ # Copyright (c) 2011 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> # +""" +Module implementing the Windows entry point. +""" + from eric5_webbrowser import main main()
--- a/eric5config.py Sun Sep 29 15:54:10 2013 +0200 +++ b/eric5config.py Sun Sep 29 18:22:08 2013 +0200 @@ -4,7 +4,7 @@ # """ -Module containing the default configuration of the eric5 installation +Module containing the default configuration of the eric5 installation. """ import sys @@ -31,14 +31,17 @@ def getConfig(name): - ''' + """ Module function to get a configuration value. @param name the name of the configuration value (string). - ''' + @return requested config value + @exception AttributeError raised to indicate an invalid config entry + """ try: return _pkg_config[name] except KeyError: pass - raise AttributeError('"{0}" is not a valid configuration value'.format(name)) + raise AttributeError( + '"{0}" is not a valid configuration value'.format(name))
--- a/install.py Sun Sep 29 15:54:10 2013 +0200 +++ b/install.py Sun Sep 29 18:22:08 2013 +0200 @@ -138,7 +138,8 @@ def initGlobals(): """ - Sets the values of globals that need more than a simple assignment. + Module function to set the values of globals that need more than a + simple assignment. """ global platBinDir, modDir, pyModDir, apisDir
--- a/patch_modpython.py Sun Sep 29 15:54:10 2013 +0200 +++ b/patch_modpython.py Sun Sep 29 18:22:08 2013 +0200 @@ -23,7 +23,7 @@ """ Display a usage message and exit. - rcode is the return code passed back to the calling process. + @param rcode return code passed back to the calling process (integer) """ global progName, modDir @@ -44,7 +44,8 @@ def initGlobals(): """ - Sets the values of globals that need more than a simple assignment. + Module function to set the values of globals that need more than a + simple assignment. """ global modDir @@ -52,9 +53,10 @@ def main(argv): - """The main function of the script. + """ + The main function of the script. - argv is the list of command line arguments. + @param argv list of command line arguments (list of strings) """ import getopt
--- a/uninstall.py Sun Sep 29 15:54:10 2013 +0200 +++ b/uninstall.py Sun Sep 29 18:22:08 2013 +0200 @@ -38,7 +38,8 @@ def usage(rcode=2): - """Display a usage message and exit. + """ + Display a usage message and exit. rcode is the return code passed back to the calling process. """ @@ -54,7 +55,7 @@ def initGlobals(): """ - Sets the values of globals that need more than a simple assignment. + Set the values of globals that need more than a simple assignment. """ global pyModDir @@ -62,7 +63,8 @@ def wrapperName(dname, wfile): - """Create the platform specific name for the wrapper script. + """ + Create the platform specific name for the wrapper script. """ if sys.platform.startswith("win"): wname = dname + "\\" + wfile + ".bat" @@ -158,7 +160,8 @@ def main(argv): - """The main function of the script. + """ + The main function of the script. argv is the list of command line arguments. """
