UI/UserInterface.py

changeset 2965
d133c7edd88a
parent 2933
ada56f070ef4
child 3012
d177226027e2
--- 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("@@"):

eric ide

mercurial