Started correcting doc strings by using the new doc string checker.

Sat, 28 Sep 2013 19:06:25 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 28 Sep 2013 19:06:25 +0200
changeset 2953
703452a2876f
parent 2952
94fc661a54a2
child 2954
bf0215fe12d1

Started correcting doc strings by using the new doc string checker.

Cooperation/ChatWidget.py file | annotate | diff | comparison | revisions
Cooperation/Connection.py file | annotate | diff | comparison | revisions
DataViews/CodeMetrics.py file | annotate | diff | comparison | revisions
DataViews/PyProfileDialog.py file | annotate | diff | comparison | revisions
DebugClients/Python/AsyncFile.py file | annotate | diff | comparison | revisions
DebugClients/Python/AsyncIO.py file | annotate | diff | comparison | revisions
DebugClients/Python/DebugBase.py file | annotate | diff | comparison | revisions
DebugClients/Python/DebugClientBase.py file | annotate | diff | comparison | revisions
DebugClients/Python/FlexCompleter.py file | annotate | diff | comparison | revisions
DebugClients/Python/PyProfile.py file | annotate | diff | comparison | revisions
DebugClients/Python/__init__.py file | annotate | diff | comparison | revisions
DebugClients/Python/eric5dbgstub.py file | annotate | diff | comparison | revisions
DebugClients/Python3/AsyncFile.py file | annotate | diff | comparison | revisions
DebugClients/Python3/AsyncIO.py file | annotate | diff | comparison | revisions
DebugClients/Python3/DebugBase.py file | annotate | diff | comparison | revisions
DebugClients/Python3/DebugClientBase.py file | annotate | diff | comparison | revisions
DebugClients/Python3/FlexCompleter.py file | annotate | diff | comparison | revisions
DebugClients/Python3/PyProfile.py file | annotate | diff | comparison | revisions
DebugClients/Python3/__init__.py file | annotate | diff | comparison | revisions
DebugClients/Python3/eric5dbgstub.py file | annotate | diff | comparison | revisions
Debugger/BreakPointModel.py file | annotate | diff | comparison | revisions
Debugger/BreakPointViewer.py file | annotate | diff | comparison | revisions
Debugger/DebugServer.py file | annotate | diff | comparison | revisions
Debugger/DebugViewer.py file | annotate | diff | comparison | revisions
Debugger/DebuggerInterfaceRuby.py file | annotate | diff | comparison | revisions
Debugger/EditBreakpointDialog.py file | annotate | diff | comparison | revisions
Debugger/VariablesViewer.py file | annotate | diff | comparison | revisions
Debugger/WatchPointModel.py file | annotate | diff | comparison | revisions
Debugger/WatchPointViewer.py file | annotate | diff | comparison | revisions
Debugger/__init__.py file | annotate | diff | comparison | revisions
DocumentationTools/APIGenerator.py file | annotate | diff | comparison | revisions
DocumentationTools/ModuleDocumentor.py file | annotate | diff | comparison | revisions
E5Graphics/E5GraphicsView.py file | annotate | diff | comparison | revisions
E5Gui/E5Action.py file | annotate | diff | comparison | revisions
E5Gui/E5ComboBox.py file | annotate | diff | comparison | revisions
E5Gui/E5ErrorMessage.py file | annotate | diff | comparison | revisions
E5Gui/E5Led.py file | annotate | diff | comparison | revisions
E5Gui/E5LineEdit.py file | annotate | diff | comparison | revisions
E5Gui/E5ModelMenu.py file | annotate | diff | comparison | revisions
E5Gui/E5PasswordMeter.py file | annotate | diff | comparison | revisions
E5Gui/E5SideBar.py file | annotate | diff | comparison | revisions
E5Gui/E5TabWidget.py file | annotate | diff | comparison | revisions
E5Gui/E5TextSpinBox.py file | annotate | diff | comparison | revisions
E5Gui/E5ToolBarDialog.py file | annotate | diff | comparison | revisions
E5Gui/E5ToolBarManager.py file | annotate | diff | comparison | revisions
E5Gui/E5TreeWidget.py file | annotate | diff | comparison | revisions
E5Gui/E5ZoomWidget.py file | annotate | diff | comparison | revisions
E5Network/E5NetworkMonitor.py file | annotate | diff | comparison | revisions
E5XML/XMLStreamReaderBase.py file | annotate | diff | comparison | revisions
Graphics/ApplicationDiagramBuilder.py file | annotate | diff | comparison | revisions
Graphics/AssociationItem.py file | annotate | diff | comparison | revisions
Graphics/GraphicsUtilities.py file | annotate | diff | comparison | revisions
Graphics/ImportsDiagramBuilder.py file | annotate | diff | comparison | revisions
Graphics/PackageDiagramBuilder.py file | annotate | diff | comparison | revisions
Graphics/UMLClassDiagramBuilder.py file | annotate | diff | comparison | revisions
Graphics/UMLDiagramBuilder.py file | annotate | diff | comparison | revisions
Graphics/UMLDialog.py file | annotate | diff | comparison | revisions
Graphics/UMLGraphicsView.py file | annotate | diff | comparison | revisions
Helpviewer/AdBlock/AdBlockDialog.py file | annotate | diff | comparison | revisions
Helpviewer/AdBlock/AdBlockNetwork.py file | annotate | diff | comparison | revisions
Helpviewer/AdBlock/AdBlockRule.py file | annotate | diff | comparison | revisions
Helpviewer/AdBlock/AdBlockTreeWidget.py file | annotate | diff | comparison | revisions
eric5.e4p file | annotate | diff | comparison | revisions
--- a/Cooperation/ChatWidget.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Cooperation/ChatWidget.py	Sat Sep 28 19:06:25 2013 +0200
@@ -370,6 +370,8 @@
     def getClient(self):
         """
         Public method to get a reference to the cooperation client.
+        
+        @return reference to the cooperation client (CooperationClient)
         """
         return self.__client
     
--- a/Cooperation/Connection.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Cooperation/Connection.py	Sat Sep 28 19:06:25 2013 +0200
@@ -117,6 +117,7 @@
         Public method to set the greeting message.
         
         @param message greeting message (string)
+        @param serverPort port number to include in the message (integer)
         """
         self.__greetingMessage = "{0}:{1}".format(message, serverPort)
     
--- a/DataViews/CodeMetrics.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DataViews/CodeMetrics.py	Sat Sep 28 19:06:25 2013 +0200
@@ -38,7 +38,7 @@
         """
         Constructor
         
-        @param **kw list of key, value pairs
+        @keyparam **kw list of key, value pairs
         """
         self.__dict__.update(kw)
 
@@ -126,6 +126,7 @@
         Public method used to decrement the indentation level.
         
         @param tok the token to be processed (Token)
+        @exception ValueError raised to indicate an invalid indentation level
         """
         self.indent_level -= 1
         if self.indent_level < 0:
@@ -259,10 +260,10 @@
 
 def main():
     """
-    Modules main function used when called as a script.
+    Module main function used when called as a script.
     
-    This function simply loops over all files given on the commandline
-    and collects the individual and overall source code statistics.
+    Loop over all files given on the command line and collect the individual
+    and overall source code statistics.
     """
     import sys
     
--- a/DataViews/PyProfileDialog.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DataViews/PyProfileDialog.py	Sat Sep 28 19:06:25 2013 +0200
@@ -29,6 +29,7 @@
         Private method to get the value to compare on for the first column.
         
         @param itm item to operate on (ProfileTreeWidgetItem)
+        @return comparison value for the first column (integer)
         """
         s = itm.text(0)
         return int(s.split('/')[0])
--- a/DebugClients/Python/AsyncFile.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python/AsyncFile.py	Sat Sep 28 19:06:25 2013 +0200
@@ -60,6 +60,7 @@
         the mode of the file. If it is not, an IOError is raised.
         
         @param mode the mode to be checked (string)
+        @exception IOError raised to indicate a bad file descriptor
         """
         if mode != self.mode:
             raise IOError('[Errno 9] Bad file descriptor')
@@ -235,6 +236,8 @@
         """
         Public method to move the filepointer.
         
+        @param offset offset to seek for
+        @param whence where to seek from
         @exception IOError This method is not supported and always raises an
         IOError.
         """
@@ -253,6 +256,7 @@
         """
         Public method to truncate the file.
         
+        @param size size to truncate to (integer)
         @exception IOError This method is not supported and always raises an
         IOError.
         """
@@ -263,6 +267,7 @@
         Public method to write a string to the file.
         
         @param s bytes to be written (string)
+        @exception socket.error raised to indicate too many send attempts
         """
         self.__checkMode('w')
         tries = 0
--- a/DebugClients/Python/AsyncIO.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python/AsyncIO.py	Sat Sep 28 19:06:25 2013 +0200
@@ -15,8 +15,6 @@
     def __init__(self):
         """
         Constructor
-        
-        @param parent the optional parent of this object (QObject) (ignored)
         """
         # There is no connection yet.
         self.disconnect()
--- a/DebugClients/Python/DebugBase.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python/DebugBase.py	Sat Sep 28 19:06:25 2013 +0200
@@ -147,9 +147,10 @@
         Public method used to trace some stuff independent of the debugger
         trace function.
         
-        @param frame The current stack frame.
-        @param event The trace event (string)
-        @param arg The arguments
+        @param frame current stack frame.
+        @param event trace event (string)
+        @param arg arguments
+        @exception RuntimeError raised to indicate too many recursions
         """
         if event == 'return':
             self.cFrame = frame.f_back
@@ -236,6 +237,7 @@
         
         @param frame The current stack frame.
         @return local trace function
+        @exception bdb.BdbQuit raised to indicate the end of the debug session
         """
         if self.stop_here(frame) or self.break_here(frame):
             self.user_line(frame)
@@ -250,6 +252,7 @@
         @param frame The current stack frame.
         @param arg The arguments
         @return local trace function
+        @exception bdb.BdbQuit raised to indicate the end of the debug session
         """
         if self.stop_here(frame) or frame == self.returnframe:
             self.user_return(frame, arg)
@@ -264,6 +267,7 @@
         @param frame The current stack frame.
         @param arg The arguments
         @return local trace function
+        @exception bdb.BdbQuit raised to indicate the end of the debug session
         """
         if not self.__skip_it(frame):
             self.user_exception(frame, arg)
@@ -319,6 +323,7 @@
         code over a network... This logic deals with that.
         
         @param frame the frame object
+        @return fixed up file name (string)
         """
         # get module name from __file__
         if '__file__' in frame.f_globals and \
@@ -375,6 +380,7 @@
         Public method to get a watch expression.
         
         @param cond expression of the watch expression to be cleared (string)
+        @return reference to the watch point
         """
         possibles = bdb.Breakpoint.bplist["Watch", 0]
         for i in range(0, len(possibles)):
@@ -500,8 +506,8 @@
         Because eric5 supports only one breakpoint per line, this overwritten
         method will return this one and only breakpoint.
         
-        @param filename the filename of the bp to retrieve (string)
-        @param ineno the linenumber of the bp to retrieve (integer)
+        @param filename filename of the bp to retrieve (string)
+        @param lineno linenumber of the bp to retrieve (integer)
         @return breakpoint or None, if there is no bp
         """
         filename = self.canonic(filename)
--- a/DebugClients/Python/DebugClientBase.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python/DebugClientBase.py	Sat Sep 28 19:06:25 2013 +0200
@@ -38,8 +38,9 @@
     
     This function works with the split debugger.
     
-    @param prompt The prompt to be shown. (string)
-    @param echo Flag indicating echoing of the input (boolean)
+    @param prompt prompt to be shown. (string)
+    @param echo flag indicating echoing of the input (boolean)
+    @return result of the raw_input() call
     """
     if DebugClientInstance is None or DebugClientInstance.redirect == 0:
         return DebugClientOrigRawInput(prompt)
@@ -64,7 +65,8 @@
     
     This function works with the split debugger.
     
-    @param prompt The prompt to be shown. (string)
+    @param prompt prompt to be shown (string)
+    @return result of the input() call
     """
     if DebugClientInstance is None or DebugClientInstance.redirect == 0:
         return DebugClientOrigInput(prompt)
@@ -86,6 +88,8 @@
 def DebugClientFork():
     """
     Replacement for the standard os.fork().
+    
+    @return result of the fork() call
     """
     if DebugClientInstance is None:
         return DebugClientOrigFork()
@@ -296,7 +300,6 @@
         @param kwargs keyword arguments to pass to target
         @param mainThread non-zero, if we are attaching to the already
               started mainthread of the app
-        @return The identifier of the created thread
         """
         if self.debugging:
             sys.setprofile(self.profile)
@@ -349,7 +352,7 @@
         
     def __exceptionRaised(self):
         """
-        Private method called in the case of an exception
+        Private method called in the case of an exception.
         
         It ensures that the debug server is informed of the raised exception.
         """
@@ -1203,6 +1206,8 @@
     def getRunning(self):
         """
         Public method to return the main script we are currently running.
+        
+        @return flag indicating a running debug session (boolean)
         """
         return self.running
 
@@ -2022,7 +2027,10 @@
         
     def fork(self):
         """
-        Public method implementing a fork routine deciding which branch to follow.
+        Public method implementing a fork routine deciding which branch to
+        follow.
+        
+        @return process ID (integer)
         """
         if not self.fork_auto:
             self.write(DebugProtocol.RequestForkTo + '\n')
--- a/DebugClients/Python/FlexCompleter.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python/FlexCompleter.py	Sat Sep 28 19:06:25 2013 +0200
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-Word completion for the eric5 shell
+Word completion for the eric5 shell.
 
 <h4>NOTE for eric5 variant</h4>
 
@@ -123,9 +123,9 @@
 
         readline.set_completer(Completer(my_namespace).complete)
         
-        @param namespace The namespace for the completer.
+        @param namespace namespace for the completer
+        @exception TypeError raised to indicate a wrong namespace structure
         """
-        
         if namespace and type(namespace) != type({}):
             raise TypeError('namespace must be a dictionary')
 
--- a/DebugClients/Python/PyProfile.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python/PyProfile.py	Sat Sep 28 19:06:25 2013 +0200
@@ -111,6 +111,7 @@
         code over a network... This logic deals with that.
         
         @param frame the frame object
+        @return fixed up file name (string)
         """
         # get module name from __file__
         if not isinstance(frame, profile.Profile.fake_frame) and \
@@ -129,6 +130,10 @@
         
         This is a variant of the one found in the standard Python
         profile.py calling fix_frame_filename above.
+        
+        @param frame reference to the call frame
+        @param t arguments of the call
+        @return flag indicating a handled call
         """
         if self.cur and frame.f_back is not self.cur[-2]:
             rpt, rit, ret, rfn, rframe, rcur = self.cur
--- a/DebugClients/Python/__init__.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python/__init__.py	Sat Sep 28 19:06:25 2013 +0200
@@ -4,7 +4,7 @@
 #
 
 """
-Package implementing the Python debugger
+Package implementing the Python debugger.
 
 It consists of different kinds of debug clients.
 """
--- a/DebugClients/Python/eric5dbgstub.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python/eric5dbgstub.py	Sat Sep 28 19:06:25 2013 +0200
@@ -29,6 +29,8 @@
     
     @param kind type of debugger ("standard" or "threads")
     @return flag indicating success (boolean)
+    @exception ValueError raised to indicate an invalid debugger kind
+        was requested
     """
     global debugger
     res = 1
--- a/DebugClients/Python3/AsyncFile.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python3/AsyncFile.py	Sat Sep 28 19:06:25 2013 +0200
@@ -63,6 +63,7 @@
         the mode of the file. If it is not, an IOError is raised.
         
         @param mode the mode to be checked (string)
+        @exception IOError raised to indicate a bad file descriptor
         """
         if mode != self.mode:
             raise IOError((9, '[Errno 9] Bad file descriptor'))
@@ -293,6 +294,7 @@
         Public method to write a string to the file.
         
         @param s bytes to be written (string)
+        @exception socket.error raised to indicate too many send attempts
         """
         self.__checkMode('w')
         tries = 0
--- a/DebugClients/Python3/AsyncIO.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python3/AsyncIO.py	Sat Sep 28 19:06:25 2013 +0200
@@ -15,8 +15,6 @@
     def __init__(self):
         """
         Constructor
-        
-        @param parent the optional parent of this object (QObject) (ignored)
         """
         # There is no connection yet.
         self.disconnect()
--- a/DebugClients/Python3/DebugBase.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python3/DebugBase.py	Sat Sep 28 19:06:25 2013 +0200
@@ -146,9 +146,10 @@
         Public method used to trace some stuff independent of the debugger
         trace function.
         
-        @param frame The current stack frame.
-        @param event The trace event (string)
-        @param arg The arguments
+        @param frame current stack frame.
+        @param event trace event (string)
+        @param arg arguments
+        @exception RuntimeError raised to indicate too many recursions
         """
         if event == 'return':
             self.cFrame = frame.f_back
@@ -235,6 +236,7 @@
         
         @param frame The current stack frame.
         @return local trace function
+        @exception bdb.BdbQuit raised to indicate the end of the debug session
         """
         if self.stop_here(frame) or self.break_here(frame):
             self.user_line(frame)
@@ -249,6 +251,7 @@
         @param frame The current stack frame.
         @param arg The arguments
         @return local trace function
+        @exception bdb.BdbQuit raised to indicate the end of the debug session
         """
         if self.stop_here(frame) or frame == self.returnframe:
             self.user_return(frame, arg)
@@ -263,6 +266,7 @@
         @param frame The current stack frame.
         @param arg The arguments
         @return local trace function
+        @exception bdb.BdbQuit raised to indicate the end of the debug session
         """
         if not self.__skip_it(frame):
             self.user_exception(frame, arg)
@@ -318,6 +322,7 @@
         code over a network... This logic deals with that.
         
         @param frame the frame object
+        @return fixed up file name (string)
         """
         # get module name from __file__
         if '__file__' in frame.f_globals and \
@@ -378,6 +383,7 @@
         Public method to get a watch expression.
         
         @param cond expression of the watch expression to be cleared (string)
+        @return reference to the watch point
         """
         possibles = bdb.Breakpoint.bplist["Watch", 0]
         for i in range(0, len(possibles)):
@@ -719,6 +725,7 @@
         type object.
         
         @param exctype type of the exception
+        @return exception name (string)
         """
         return str(exctype).replace("<class '", "").replace("'>", "")
     
--- a/DebugClients/Python3/DebugClientBase.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python3/DebugClientBase.py	Sat Sep 28 19:06:25 2013 +0200
@@ -38,7 +38,9 @@
     
     This function works with the split debugger.
     
-    @param prompt The prompt to be shown. (string)
+    @param prompt prompt to be shown (string)
+    @param echo flag indicating to echo the output (boolean)
+    @return result of the input() call
     """
     if DebugClientInstance is None or not DebugClientInstance.redirect:
         return DebugClientOrigInput(prompt)
@@ -60,6 +62,8 @@
 def DebugClientFork():
     """
     Replacement for the standard os.fork().
+    
+    @return result of the fork() call
     """
     if DebugClientInstance is None:
         return DebugClientOrigFork()
@@ -264,7 +268,6 @@
         @param kwargs keyword arguments to pass to target
         @param mainThread True, if we are attaching to the already
               started mainthread of the app
-        @return The identifier of the created thread
         """
         if self.debugging:
             sys.setprofile(self.profile)
@@ -308,7 +311,7 @@
 
     def __exceptionRaised(self):
         """
-        Private method called in the case of an exception
+        Private method called in the case of an exception.
         
         It ensures that the debug server is informed of the raised exception.
         """
@@ -1213,6 +1216,8 @@
     def getRunning(self):
         """
         Public method to return the main script we are currently running.
+        
+        @return flag indicating a running debug session (boolean)
         """
         return self.running
 
@@ -2065,7 +2070,10 @@
         
     def fork(self):
         """
-        Public method implementing a fork routine deciding which branch to follow.
+        Public method implementing a fork routine deciding which branch
+        to follow.
+        
+        @return process ID (integer)
         """
         if not self.fork_auto:
             self.write(DebugProtocol.RequestForkTo + '\n')
--- a/DebugClients/Python3/FlexCompleter.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python3/FlexCompleter.py	Sat Sep 28 19:06:25 2013 +0200
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-Word completion for the eric5 shell
+Word completion for the eric5 shell.
 
 <h4>NOTE for eric5 variant</h4>
 
@@ -74,8 +74,9 @@
         readline.set_completer(Completer(my_namespace).complete)
         
         @param namespace The namespace for the completer.
+        @exception TypeError raised to indicate a wrong data structure of
+            the namespace object
         """
-        
         if namespace and type(namespace) != type({}):
             raise TypeError('namespace must be a dictionary')
 
--- a/DebugClients/Python3/PyProfile.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python3/PyProfile.py	Sat Sep 28 19:06:25 2013 +0200
@@ -113,6 +113,7 @@
         code over a network... This logic deals with that.
         
         @param frame the frame object
+        @return fixed up file name (string)
         """
         # get module name from __file__
         if not isinstance(frame, profile.Profile.fake_frame) and \
@@ -135,6 +136,10 @@
         
         This is a variant of the one found in the standard Python
         profile.py calling fix_frame_filename above.
+        
+        @param frame reference to the call frame
+        @param t arguments
+        @return flag indicating a successful handling (boolean)
         """
         if self.cur and frame.f_back is not self.cur[-2]:
             rpt, rit, ret, rfn, rframe, rcur = self.cur
--- a/DebugClients/Python3/__init__.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python3/__init__.py	Sat Sep 28 19:06:25 2013 +0200
@@ -4,7 +4,7 @@
 #
 
 """
-Package implementing the Python3 debugger
+Package implementing the Python3 debugger.
 
 It consists of different kinds of debug clients.
 """
--- a/DebugClients/Python3/eric5dbgstub.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python3/eric5dbgstub.py	Sat Sep 28 19:06:25 2013 +0200
@@ -29,6 +29,7 @@
     
     @param kind type of debugger ("standard" or "threads")
     @return flag indicating success (boolean)
+    @exception ValueError raised to indicate a wrong debugger kind
     """
     global debugger
     res = True
--- a/Debugger/BreakPointModel.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Debugger/BreakPointModel.py	Sat Sep 28 19:06:25 2013 +0200
@@ -20,7 +20,7 @@
         """
         Constructor
         
-        @param reference to the parent widget (QObject)
+        @param parent reference to the parent widget (QObject)
         """
         super().__init__(parent)
         
@@ -46,6 +46,7 @@
         """
         Public method to get the current column count.
         
+        @param parent reference to parent index (QModelIndex)
         @return column count (integer)
         """
         return len(self.header)
@@ -54,6 +55,7 @@
         """
         Public method to get the current row count.
         
+        @param parent reference to parent index (QModelIndex)
         @return row count (integer)
         """
         # we do not have a tree, parent should always be invalid
@@ -284,7 +286,7 @@
         Public method to get the index of a breakpoint given by filename and line number.
         
         @param fn filename of the breakpoint (string)
-        @param line line number of the breakpoint (integer)
+        @param lineno line number of the breakpoint (integer)
         @return index (QModelIndex)
         """
         for row in range(len(self.breakpoints)):
--- a/Debugger/BreakPointViewer.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Debugger/BreakPointViewer.py	Sat Sep 28 19:06:25 2013 +0200
@@ -58,7 +58,7 @@
         """
         Public slot to set the breakpoint model.
         
-        @param reference to the breakpoint model (BreakPointModel)
+        @param model reference to the breakpoint model (BreakPointModel)
         """
         self.__model = model
         
@@ -105,6 +105,7 @@
         Private slot to convert an index to a source index.
         
         @param index index to be converted (QModelIndex)
+        @return mapped index (QModelIndex)
         """
         return self.sortingModel.mapToSource(index)
         
@@ -113,6 +114,7 @@
         Private slot to convert a source index to an index.
         
         @param sindex source index to be converted (QModelIndex)
+        @return mapped index (QModelIndex)
         """
         return self.sortingModel.mapFromSource(sindex)
         
--- a/Debugger/DebugServer.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Debugger/DebugServer.py	Sat Sep 28 19:06:25 2013 +0200
@@ -445,7 +445,8 @@
         """
         Private slot to set changed breakpoints.
         
-        @param indexes indexes of changed breakpoints.
+        @param startIndex starting index of the change breakpoins (QModelIndex)
+        @param endIndex ending index of the change breakpoins (QModelIndex)
         """
         if self.debugging:
             self.__addBreakPoints(QModelIndex(), startIndex.row(), endIndex.row())
@@ -1098,7 +1099,7 @@
         """
         Public method to process the client thread list info.
         
-        @param currentID id of the current thread (integer)
+        @param currentId id of the current thread (integer)
         @param threadList list of dictionaries containing the thread data
         """
         self.clientThreadList.emit(currentId, threadList)
--- a/Debugger/DebugViewer.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Debugger/DebugViewer.py	Sat Sep 28 19:06:25 2013 +0200
@@ -430,7 +430,7 @@
         
     def __setGlobalsFilter(self):
         """
-        Private slot to set the global variable filter
+        Private slot to set the global variable filter.
         """
         filter = self.globalsFilterEdit.text()
         self.debugServer.remoteClientSetFilter(1, filter)
@@ -439,7 +439,7 @@
         
     def __setLocalsFilter(self):
         """
-        Private slot to set the local variable filter
+        Private slot to set the local variable filter.
         """
         filter = self.localsFilterEdit.text()
         self.debugServer.remoteClientSetFilter(0, filter)
--- a/Debugger/DebuggerInterfaceRuby.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Debugger/DebuggerInterfaceRuby.py	Sat Sep 28 19:06:25 2013 +0200
@@ -439,6 +439,8 @@
         @param wd the working directory for the program (string)
         @keyparam erase flag indicating that coverage info should be
             cleared first (boolean)
+        @exception NotImplementedError raised to indicate that this interface
+            is not supported
         """
         raise NotImplementedError("Interface not available.")
 
@@ -450,6 +452,8 @@
         @param argv the commandline arguments to pass to the program (string)
         @param wd the working directory for the program (string)
         @keyparam erase flag indicating that timing info should be cleared first (boolean)
+        @exception NotImplementedError raised to indicate that this interface
+            is not supported
         """
         raise NotImplementedError("Interface not available.")
 
@@ -680,18 +684,26 @@
         @param covname filename to be used to assemble the coverage caches
                 filename (string)
         @param coverase flag indicating erasure of coverage data is requested (boolean)
+        @exception NotImplementedError raised to indicate that this interface
+            is not supported
         """
         raise NotImplementedError("Interface not available.")
         
     def remoteUTRun(self):
         """
         Public method to start a unittest run.
+        
+        @exception NotImplementedError raised to indicate that this interface
+            is not supported
         """
         raise NotImplementedError("Interface not available.")
         
     def remoteUTStop(self):
         """
-        public method to stop a unittest run.
+        Public method to stop a unittest run.
+        
+        @exception NotImplementedError raised to indicate that this interface
+            is not supported
         """
         raise NotImplementedError("Interface not available.")
         
--- a/Debugger/EditBreakpointDialog.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Debugger/EditBreakpointDialog.py	Sat Sep 28 19:06:25 2013 +0200
@@ -34,9 +34,12 @@
         @param properties properties for the breakpoint (tuple)
                 (condition, temporary flag, enabled flag, ignore count)
         @param condHistory the list of conditionals history (list of strings)
-        @param parent the parent of this dialog
-        @param name the widget name of this dialog
-        @param modal flag indicating a modal dialog
+        @param parent the parent of this dialog (QWidget)
+        @param name the widget name of this dialog (string)
+        @param modal flag indicating a modal dialog (boolean)
+        @param addMode flag indicating the add mode (boolean)
+        @param filenameHistory list of recently used file names
+            (list of strings)
         """
         super().__init__(parent)
         self.setupUi(self)
--- a/Debugger/VariablesViewer.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Debugger/VariablesViewer.py	Sat Sep 28 19:06:25 2013 +0200
@@ -211,6 +211,7 @@
         Public method generating the key for this item.
         
         @param column the column to sort on (integer)
+        @return key of the item (string)
         """
         if column == 0:
             return self.arrayElementKey
@@ -249,6 +250,7 @@
         Public method generating the key for this item.
         
         @param column the column to sort on (integer)
+        @return key of the item (string)
         """
         if column == 0:
             return self.arrayElementKey
--- a/Debugger/WatchPointModel.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Debugger/WatchPointModel.py	Sat Sep 28 19:06:25 2013 +0200
@@ -20,7 +20,7 @@
         """
         Constructor
         
-        @param reference to the parent widget (QObject)
+        @param parent reference to the parent widget (QObject)
         """
         super().__init__(parent)
         
@@ -43,6 +43,7 @@
         """
         Public method to get the current column count.
         
+        @param parent index of the parent item (QModelIndex)
         @return column count (integer)
         """
         return len(self.header)
@@ -51,6 +52,7 @@
         """
         Public method to get the current row count.
         
+        @param parent index of the parent item (QModelIndex)
         @return row count (integer)
         """
         # we do not have a tree, parent should always be invalid
--- a/Debugger/WatchPointViewer.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Debugger/WatchPointViewer.py	Sat Sep 28 19:06:25 2013 +0200
@@ -53,7 +53,7 @@
         """
         Public slot to set the watch expression model.
         
-        @param reference to the watch expression model (WatchPointModel)
+        @param model reference to the watch expression model (WatchPointModel)
         """
         self.__model = model
         
@@ -100,6 +100,7 @@
         Private slot to convert an index to a source index.
         
         @param index index to be converted (QModelIndex)
+        @return mapped index (QModelIndex)
         """
         return self.sortingModel.mapToSource(index)
         
@@ -108,6 +109,7 @@
         Private slot to convert a source index to an index.
         
         @param sindex source index to be converted (QModelIndex)
+        @return mapped index (QModelIndex)
         """
         return self.sortingModel.mapFromSource(sindex)
         
--- a/Debugger/__init__.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Debugger/__init__.py	Sat Sep 28 19:06:25 2013 +0200
@@ -4,7 +4,7 @@
 #
 
 """
-Package implementing the Debugger frontend
+Package implementing the Debugger frontend.
 
 This package implements the graphical debugger. It consists
 of the debugger related HMI part, supporting dialogs and the debug server.
--- a/DocumentationTools/APIGenerator.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DocumentationTools/APIGenerator.py	Sat Sep 28 19:06:25 2013 +0200
@@ -5,7 +5,6 @@
 
 """
 Module implementing the builtin API generator.
-
 """
 
 
@@ -105,7 +104,7 @@
         """
         Private method to generate the api section for class methods.
         
-        @param classname Name of the class containing the method. (string)
+        @param className name of the class containing the method (string)
         """
         from QScintilla.Editor import Editor
         
@@ -140,7 +139,7 @@
         """
         Private method to generate class api section for class variables.
         
-        @param classname Name of the class containing the class variables. (string)
+        @param className name of the class containing the class variables (string)
         """
         from QScintilla.Editor import Editor
         
--- a/DocumentationTools/ModuleDocumentor.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DocumentationTools/ModuleDocumentor.py	Sat Sep 28 19:06:25 2013 +0200
@@ -50,6 +50,7 @@
     """
     Exception class raised, if an invalid documentation tag was found.
     """
+    pass
 
 
 class ModuleDocument(object):
@@ -689,8 +690,8 @@
         Private method to check, if the object to be documented contains a
         deprecated flag.
         
-        @param desc The documentation string. (string)
-        @return Flag indicating the deprecation status. (boolean)
+        @param descr documentation string (string)
+        @return flag indicating the deprecation status (boolean)
         """
         dlist = descr.splitlines()
         for desc in dlist:
@@ -819,6 +820,7 @@
         
         @param desc One line of the description (string)
         @return processed line with inline tags expanded (string)
+        @exception TagError raised to indicate an invalid tag
         """
         start = desc.find('{@')
         while start != -1:
--- a/E5Graphics/E5GraphicsView.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Graphics/E5GraphicsView.py	Sat Sep 28 19:06:25 2013 +0200
@@ -128,8 +128,8 @@
         """
         Public method to resize the scene.
         
+        @param amount size increment (integer)
         @param isWidth flag indicating width is to be resized (boolean)
-        @param amount size increment (integer)
         """
         sceneRect = self.scene().sceneRect()
         width = sceneRect.width()
--- a/E5Gui/E5Action.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5Action.py	Sat Sep 28 19:06:25 2013 +0200
@@ -21,6 +21,8 @@
     def __init__(self, error):
         """
         Constructor
+        
+        @param error error message of the exception (string)
         """
         self.errorMessage = str(error)
         
@@ -64,6 +66,7 @@
                 accelarator (QKeySequence), alternative accelerator (QKeySequence),
                 parent (QObject), name (string)</li>
             </ul>
+        @exception ArgumentsError raised to indicate invalid arguments
         """
         if isinstance(args[1], QIcon):
             icon = args[1]
--- a/E5Gui/E5ComboBox.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5ComboBox.py	Sat Sep 28 19:06:25 2013 +0200
@@ -35,7 +35,7 @@
         """
         Public method to get the inactive text.
         
-        return inactive text (string)
+        @return inactive text (string)
         """
         return self.__lineedit.inactiveText()
     
--- a/E5Gui/E5ErrorMessage.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5ErrorMessage.py	Sat Sep 28 19:06:25 2013 +0200
@@ -142,6 +142,8 @@
     """
     Module function to install an E5ErrorMessage dialog as the global
     message handler.
+    
+    @return reference to the message handler dialog (E5ErrorMessage)
     """
     global __msgHandlerDialog, __origMsgHandler
     
--- a/E5Gui/E5Led.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5Led.py	Sat Sep 28 19:06:25 2013 +0200
@@ -27,7 +27,7 @@
         @param parent reference to parent widget (QWidget)
         @param color color of the LED (QColor)
         @param shape shape of the LED (E5LedCircular, E5LedRectangular)
-        @param rectRation ratio width to height, if shape is rectangular (float)
+        @param rectRatio ratio width to height, if shape is rectangular (float)
         """
         super().__init__(parent)
         
@@ -140,7 +140,7 @@
         
     def ratio(self):
         """
-        Public method to return the LED rectangular ratio (width / height).
+        Public method to return the LED rectangular ratio [= width / height].
         
         @return LED rectangular ratio (float)
         """
--- a/E5Gui/E5LineEdit.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5LineEdit.py	Sat Sep 28 19:06:25 2013 +0200
@@ -32,7 +32,7 @@
         """
         Protected method to handle events.
         
-        @param reference to the event (QEvent)
+        @param evt reference to the event (QEvent)
         @return flag indicating, whether the event was recognized (boolean)
         """
         if evt.type() == QEvent.LayoutRequest:
@@ -122,7 +122,7 @@
         """
         Protected method to handle events.
         
-        @param reference to the event (QEvent)
+        @param evt reference to the event (QEvent)
         @return flag indicating, whether the event was recognized (boolean)
         """
         if evt.type() == QEvent.LayoutDirectionChange:
@@ -231,6 +231,7 @@
         Public method to get the text margin for a side.
         
         @param position side to get margin for (E5LineEdit.LeftSide, E5LineEdit.RightSide)
+        @return text margin (integer)
         """
         spacing = self.__rightLayout.spacing()
         w = 0
@@ -246,7 +247,7 @@
         """
         Public method to get the inactive text.
         
-        return inactive text (string)
+        @return inactive text (string)
         """
         if qVersion() < "4.7.0":
             return self.__inactiveText
--- a/E5Gui/E5ModelMenu.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5ModelMenu.py	Sat Sep 28 19:06:25 2013 +0200
@@ -252,7 +252,7 @@
         
         @param icon icon of the action (QIcon)
         @param text text of the action (string)
-        @param reference to the parent object (QObject)
+        @param parent reference to the parent object (QObject)
         @return reference to the created action (QAction)
         """
         fm = QFontMetrics(self.font())
--- a/E5Gui/E5PasswordMeter.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5PasswordMeter.py	Sat Sep 28 19:06:25 2013 +0200
@@ -63,6 +63,8 @@
         Public method to set the value.
         
         Overwritten to do nothing.
+        
+        @param value value (integer)
         """
         pass
     
@@ -71,6 +73,8 @@
         Public method to set the maximum value.
         
         Overwritten to do nothing.
+        
+        @param value maximum value (integer)
         """
         pass
     
@@ -79,6 +83,8 @@
         Public method to set the minimal value.
         
         Overwritten to do nothing.
+        
+        @param value minimum value (integer)
         """
         pass
 
--- a/E5Gui/E5SideBar.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5SideBar.py	Sat Sep 28 19:06:25 2013 +0200
@@ -422,6 +422,7 @@
     def setOrientation(self, orient):
         """
         Public method to set the orientation of the sidebar.
+
         @param orient orientation of the sidebar (North, East, South, West)
         """
         if orient == E5SideBar.North:
@@ -500,7 +501,7 @@
         Public method to set the tooltip text of a tab.
         
         @param index index of the tab (integer)
-        @param tooltip text text to set (string)
+        @param tip tooltip text to set (string)
         """
         self.__tabBar.setTabToolTip(index, tip)
     
@@ -518,7 +519,7 @@
         Public method to set the WhatsThis text of a tab.
         
         @param index index of the tab (integer)
-        @param WhatsThis text text to set (string)
+        @param text WhatsThis text to set (string)
         """
         self.__tabBar.setTabWhatsThis(index, text)
     
--- a/E5Gui/E5TabWidget.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5TabWidget.py	Sat Sep 28 19:06:25 2013 +0200
@@ -28,7 +28,7 @@
         """
         Protected slot to support wheel events.
         
-        @param reference to the wheel event (QWheelEvent)
+        @param event reference to the wheel event (QWheelEvent)
         """
         try:
             if event.delta() > 0:
@@ -334,7 +334,7 @@
         @param index tab index (integer)
         """
         if index == -1:
-            return None
+            return
         
         if hasattr(self.__tabBar, 'tabButton'):
             side = self.__freeSide()
--- a/E5Gui/E5TextSpinBox.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5TextSpinBox.py	Sat Sep 28 19:06:25 2013 +0200
@@ -3,6 +3,10 @@
 # Copyright (c) 2010 - 2013 Detlev Offenbach <detlev@die-offenbachs.de>
 #
 
+"""
+Module implementing a spinbox with textual entries.
+"""
+
 from PyQt4.QtGui import QSpinBox
 
 
--- a/E5Gui/E5ToolBarDialog.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5ToolBarDialog.py	Sat Sep 28 19:06:25 2013 +0200
@@ -151,7 +151,7 @@
     @pyqtSlot()
     def on_removeButton_clicked(self):
         """
-        Private slot to remove a custom toolbar
+        Private slot to remove a custom toolbar.
         """
         name = self.toolbarComboBox.currentText()
         res = E5MessageBox.yesNo(self,
@@ -253,13 +253,21 @@
     def on_actionsTree_currentItemChanged(self, current, previous):
         """
         Private slot called, when the currently selected action changes.
+        
+        @param current reference to the current item (QTreeWidgetItem)
+        @param previous reference to the previous current item
+            (QTreeWidgetItem)
         """
         self.__setupButtons()
     
     @pyqtSlot(QListWidgetItem, QListWidgetItem)
     def on_toolbarActionsList_currentItemChanged(self, current, previous):
         """
-        Slot documentation goes here.
+        Private slot to handle a change of the current item.
+        
+        @param current reference to the current item (QListWidgetItem)
+        @param previous reference to the previous current item
+            (QListWidgetItem)
         """
         self.__setupButtons()
     
@@ -358,6 +366,8 @@
     def on_buttonBox_clicked(self, button):
         """
         Private slot called, when a button of the button box was clicked.
+        
+        @param button reference to the button clicked (QAbstractButton)
         """
         if button == self.buttonBox.button(QDialogButtonBox.Cancel):
             self.reject()
@@ -377,6 +387,8 @@
     def __saveToolBars(self):
         """
         Private method to save the configured toolbars.
+        
+        @exception RuntimeError raised to indicate an invalid action
         """
         # step 1: remove toolbars marked for deletion
         for tbID in self.__removedToolBarIDs:
--- a/E5Gui/E5ToolBarManager.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5ToolBarManager.py	Sat Sep 28 19:06:25 2013 +0200
@@ -288,6 +288,7 @@
         Public method to check, if a toolbar was added with addToolBar().
         
         @param toolBar reference to the toolbar to be checked (QToolBar)
+        @return flag indicating an added toolbar (boolean)
         """
         return toolBar is not None and \
                id(toolBar) in self.__defaultToolBars
--- a/E5Gui/E5TreeWidget.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5TreeWidget.py	Sat Sep 28 19:06:25 2013 +0200
@@ -73,6 +73,8 @@
             the parent item (QTreeWidgetItem)
         @param item item to be appended (QTreeWidgetItem)
         @return flag indicating success (boolean)
+        @exception RuntimeError raised to indicate an illegal type for
+            the parent
         """
         if isinstance(parent, QTreeWidgetItem):
             if parent is None or parent.treeWidget() != self:
@@ -100,6 +102,8 @@
             the parent item (QTreeWidgetItem)
         @param item item to be prepended (QTreeWidgetItem)
         @return flag indicating success (boolean)
+        @exception RuntimeError raised to indicate an illegal type for
+            the parent
         """
         if isinstance(parent, QTreeWidgetItem):
             if parent is None or parent.treeWidget() != self:
--- a/E5Gui/E5ZoomWidget.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5ZoomWidget.py	Sat Sep 28 19:06:25 2013 +0200
@@ -54,6 +54,8 @@
     def on_slider_sliderMoved(self, value):
         """
         Public slot to handle changes of the zoom value.
+        
+        @param value value of the slider (integer)
         """
         if self.__mapped:
             self.valueChanged.emit(self.__mapping[value])
@@ -104,7 +106,7 @@
         """
         Public method to set the maximum value.
         
-        @param minimum new maximum value (integer)
+        @param maximum new maximum value (integer)
         """
         if not self.__mapped:
             self.slider.setMaximum(maximum)
--- a/E5Network/E5NetworkMonitor.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Network/E5NetworkMonitor.py	Sat Sep 28 19:06:25 2013 +0200
@@ -46,6 +46,7 @@
         
         @param networkAccessManager reference to the network access manager
             (QNetworkAccessManager)
+        @return reference to the network monitor singleton (E5NetworkMonitor)
         """
         if cls._monitor is None:
             cls._monitor = E5NetworkMonitor(networkAccessManager)
--- a/E5XML/XMLStreamReaderBase.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5XML/XMLStreamReaderBase.py	Sat Sep 28 19:06:25 2013 +0200
@@ -95,6 +95,7 @@
         
         @param name name of the attribute (string)
         @param default default value (string)
+        @return value of the requested tag attribute (string)
         """
         att = self.attributes().value(name)
         if att == "":
--- a/Graphics/ApplicationDiagramBuilder.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Graphics/ApplicationDiagramBuilder.py	Sat Sep 28 19:06:25 2013 +0200
@@ -220,6 +220,7 @@
             (list of strings)
         @param x x-coordinate (float)
         @param y y-coordinate (float)
+        @return reference to the package item (PackageItem)
         """
         from .PackageItem import PackageItem, PackageModel
         modules.sort()
--- a/Graphics/AssociationItem.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Graphics/AssociationItem.py	Sat Sep 28 19:06:25 2013 +0200
@@ -156,7 +156,7 @@
             self.setPoints(startP.x(), startP.y(), endP.x(), endP.y())
         
     def __calculateEndingPoints_rectangle(self):
-        """
+        r"""
         Private method to calculate the ending points of the association item.
         
         The ending points are calculated by the following method.
@@ -185,8 +185,8 @@
         (lets call it region M). After that the start point will be
         the middle point of rectangle's side contained in region M.
         
-        To calculate the end point we repeat the above but in the opposite direction
-        (from itemB to itemA)
+        To calculate the end point we repeat the above but in the opposite
+        direction (from itemB to itemA)
         """
         if self.itemA is None or self.itemB is None:
             return
--- a/Graphics/GraphicsUtilities.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Graphics/GraphicsUtilities.py	Sat Sep 28 19:06:25 2013 +0200
@@ -12,7 +12,8 @@
     """
     Unable to calculate result because of recursive structure.
     """
-    
+    pass
+
 
 def sort(nodes, routes, noRecursion=False):
     """
--- a/Graphics/ImportsDiagramBuilder.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Graphics/ImportsDiagramBuilder.py	Sat Sep 28 19:06:25 2013 +0200
@@ -220,6 +220,7 @@
             (list of strings)
         @param x x-coordinate (float)
         @param y y-coordinate (float)
+        @return reference to the imports item (ModuleItem)
         """
         from .ModuleItem import ModuleItem, ModuleModel
         classes.sort()
--- a/Graphics/PackageDiagramBuilder.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Graphics/PackageDiagramBuilder.py	Sat Sep 28 19:06:25 2013 +0200
@@ -271,6 +271,11 @@
         Private method to arrange the shapes on the canvas.
         
         The algorithm is borrowed from Boa Constructor.
+        
+        @param nodes list of nodes to arrange
+        @param routes list of routes
+        @param whiteSpaceFactor factor to increase whitespace between
+            items (float)
         """
         from . import GraphicsUtilities
         generations = GraphicsUtilities.sort(nodes, routes)
--- a/Graphics/UMLClassDiagramBuilder.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Graphics/UMLClassDiagramBuilder.py	Sat Sep 28 19:06:25 2013 +0200
@@ -149,6 +149,11 @@
         Private method to arrange the shapes on the canvas.
         
         The algorithm is borrowed from Boa Constructor.
+        
+        @param nodes list of nodes to arrange
+        @param routes list of routes
+        @param whiteSpaceFactor factor to increase whitespace between
+            items (float)
         """
         from . import GraphicsUtilities
         generations = GraphicsUtilities.sort(nodes, routes)
--- a/Graphics/UMLDiagramBuilder.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Graphics/UMLDiagramBuilder.py	Sat Sep 28 19:06:25 2013 +0200
@@ -39,6 +39,9 @@
         Public method to build the diagram.
         
         This class must be implemented in subclasses.
+        
+        @exception NotImplementedError raised to indicate that this class
+            must be subclassed
         """
         raise NotImplementedError(
             "Method 'buildDiagram' must be implemented in subclasses.")
--- a/Graphics/UMLDialog.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Graphics/UMLDialog.py	Sat Sep 28 19:06:25 2013 +0200
@@ -29,18 +29,19 @@
     
     FileVersions = ["1.0"]
     
-    def __init__(self, diagramType, project, path="", parent=None, initBuilder=True,
-                 **kwargs):
+    def __init__(self, diagramType, project, path="", parent=None,
+                 initBuilder=True, **kwargs):
         """
         Constructor
         
-        @param diagramType type of the diagram (one of ApplicationDiagram, ClassDiagram,
-            ImportsDiagram, NoDiagram, PackageDiagram)
+        @param diagramType type of the diagram (one of ApplicationDiagram,
+            ClassDiagram, ImportsDiagram, NoDiagram, PackageDiagram)
         @param project reference to the project object (Project)
         @param path file or directory path to build the diagram from (string)
         @param parent parent widget of the dialog (QWidget)
-        @keyparam initBuilder flag indicating to initialize the diagram builder (boolean)
-        @param kwargs diagram specific data
+        @keyparam initBuilder flag indicating to initialize the diagram
+            builder (boolean)
+        @keyparam kwargs diagram specific data
         """
         super().__init__(parent)
         self.setObjectName("UMLDialog")
@@ -155,7 +156,9 @@
         @param diagramType type of the diagram
             (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, PackageDiagram)
         @param path file or directory path to build the diagram from (string)
-        @param kwargs diagram specific data
+        @keyparam kwargs diagram specific data
+        @return reference to the instantiated diagram builder
+        @exception ValueError raised to indicate an illegal diagram type
         """
         if diagramType == UMLDialog.ClassDiagram:
             from .UMLClassDiagramBuilder import UMLClassDiagramBuilder
--- a/Graphics/UMLGraphicsView.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Graphics/UMLGraphicsView.py	Sat Sep 28 19:06:25 2013 +0200
@@ -443,6 +443,8 @@
     def __printPreviewPrint(self, printer):
         """
         Private slot to generate a print preview.
+        
+        @param printer reference to the printer object (QPrinter)
         """
         super().printDiagram(printer, self.diagramName)
         
--- a/Helpviewer/AdBlock/AdBlockDialog.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Helpviewer/AdBlock/AdBlockDialog.py	Sat Sep 28 19:06:25 2013 +0200
@@ -25,6 +25,8 @@
     def __init__(self, parent=None):
         """
         Constructor
+        
+        @param parent reference to the parent object (QWidget)
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -227,7 +229,7 @@
     
     def __switchSubscriptionEnabled(self):
         """
-        Private slot to switch the enabled state of the selected subscription
+        Private slot to switch the enabled state of the selected subscription.
         """
         newState = not self.__currentSubscription.isEnabled()
         self.__setSubscriptionEnabled(self.__currentSubscription, newState)
--- a/Helpviewer/AdBlock/AdBlockNetwork.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Helpviewer/AdBlock/AdBlockNetwork.py	Sat Sep 28 19:06:25 2013 +0200
@@ -21,6 +21,7 @@
         """
         Public method to check for a network block.
         
+        @param request reference to the request object (QNetworkRequest)
         @return reply object (QNetworkReply) or None
         """
         url = request.url()
--- a/Helpviewer/AdBlock/AdBlockRule.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Helpviewer/AdBlock/AdBlockRule.py	Sat Sep 28 19:06:25 2013 +0200
@@ -56,6 +56,10 @@
     def __init__(self, filter="", subscription=None):
         """
         Constructor
+        
+        @param filter filter string of the rule (string)
+        @param subscription reference to the subscription object
+            (AdBlockSubscription)
         """
         self.__subscription = subscription
         
--- a/Helpviewer/AdBlock/AdBlockTreeWidget.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Helpviewer/AdBlock/AdBlockTreeWidget.py	Sat Sep 28 19:06:25 2013 +0200
@@ -23,7 +23,7 @@
         Constructor
         
         @param subscription reference to the subscription (AdBlockSubscription)
-        @param parenbt reference to the parent widget (QWidget)
+        @param parent reference to the parent widget (QWidget)
         """
         super().__init__(parent)
         
--- a/eric5.e4p	Sat Sep 28 17:40:42 2013 +0200
+++ b/eric5.e4p	Sat Sep 28 19:06:25 2013 +0200
@@ -1908,7 +1908,7 @@
               <string>ExcludeMessages</string>
             </key>
             <value>
-              <string>E24, E501, W293, N, E</string>
+              <string>E24, E501, W293, N, E, W</string>
             </value>
             <key>
               <string>FixCodes</string>

eric ide

mercurial