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

Sun, 29 Sep 2013 10:22:44 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 29 Sep 2013 10:22:44 +0200
changeset 2957
c7f8c7561542
parent 2956
615dbd8a696a
child 2958
ed0a8d4304a8

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

IconEditor/IconEditorGrid.py file | annotate | diff | comparison | revisions
IconEditor/IconEditorPalette.py file | annotate | diff | comparison | revisions
IconEditor/IconEditorWindow.py file | annotate | diff | comparison | revisions
--- a/IconEditor/IconEditorGrid.py	Sun Sep 29 10:19:28 2013 +0200
+++ b/IconEditor/IconEditorGrid.py	Sun Sep 29 10:22:44 2013 +0200
@@ -440,7 +440,7 @@
         
         @param i x-coordinate of the pixel in the image (integer)
         @param j y-coordinate of the pixel in the image (integer)
-        return rectangle for the given pixel coordinates (QRect)
+        @return rectangle for the given pixel coordinates (QRect)
         """
         if self.__zoom >= 3 and self.__gridEnabled:
             return QRect(self.__zoom * i + 1, self.__zoom * j + 1,
@@ -609,11 +609,12 @@
     
     def __drawTool(self, pos, mark):
         """
-        Public method to perform a draw operation depending of the current tool.
+        Public method to perform a draw operation depending of the current
+        tool.
         
         @param pos widget coordinate to perform the draw operation at (QPoint)
         @param mark flag indicating a mark operation (boolean)
-        @param flag indicating a successful draw (boolean)
+        @return flag indicating a successful draw (boolean)
         """
         self.__unMark()
         
--- a/IconEditor/IconEditorPalette.py	Sun Sep 29 10:19:28 2013 +0200
+++ b/IconEditor/IconEditorPalette.py	Sun Sep 29 10:22:44 2013 +0200
@@ -112,12 +112,16 @@
     def previewChanged(self, pixmap):
         """
         Public slot to update the preview.
+        
+        @param pixmap new preview pixmap (QPixmap)
         """
         self.__preview.setPixmap(pixmap)
     
     def colorChanged(self, color):
         """
         Public slot to update the color preview.
+        
+        @param color new color (QColor)
         """
         self.__currentColor = color
         self.__currentAlpha = color.alpha()
--- a/IconEditor/IconEditorWindow.py	Sun Sep 29 10:19:28 2013 +0200
+++ b/IconEditor/IconEditorWindow.py	Sun Sep 29 10:22:44 2013 +0200
@@ -992,6 +992,8 @@
     def __saveIcon(self):
         """
         Private slot to save the icon.
+        
+        @return flag indicating success (boolean)
         """
         if not self.__fileName:
             return self.__saveIconAs()
@@ -1001,6 +1003,8 @@
     def __saveIconAs(self):
         """
         Private slot to save the icon with a new name.
+        
+        @return flag indicating success (boolean)
         """
         if not self.__lastSavePath:
             if self.__project and self.__project.isOpen():

eric ide

mercurial