Added docstrings for legend_data, painter, ..., plot (except QwtPlotItem)

Author: PierreRaybaut

doc/reference/index.rst

@@ -10,3 +10,6 @@ Main `python-qwt` classes:
     graphic
     interval
     legend
+    legend_data
+    legend_label
+    plot

doc/reference/legend_data.rst

@@ -0,0 +1,2 @@
+.. automodule:: qwt.legend_data
+   :members:

doc/reference/legend_label.rst

@@ -0,0 +1,2 @@
+.. automodule:: qwt.legend_label
+   :members:

doc/reference/plot.rst

@@ -0,0 +1,2 @@
+.. automodule:: qwt.plot
+   :members:

qwt/color_map.py

@@ -163,13 +163,11 @@ def __init__(self, format_=None):
 
     def color(self, interval, value):
         """
-        .. py:method:: color(interval, value)
+        Map a value into a color
         
-            Map a value into a color
-            
-            :param qwt.interval.QwtInterval interval: valid interval for value
-            :param float value: value
-            :return: the color corresponding to value
+        :param qwt.interval.QwtInterval interval: valid interval for value
+        :param float value: value
+        :return: the color corresponding to value
         
         .. warning ::
             
@@ -188,12 +186,10 @@ def format(self):
 
     def colorTable(self, interval):
         """
-        .. py:method:: colorTable(interval)
+        Build and return a color map of 256 colors
         
-            Build and return a color map of 256 colors
-            
-            :param qwt.interval.QwtInterval interval: range for the values
-            :return: a color table, that can be used for a `QImage`
+        :param qwt.interval.QwtInterval interval: range for the values
+        :return: a color table, that can be used for a `QImage`
 
         The color table is needed for rendering indexed images in combination
         with using `colorIndex()`.
@@ -257,11 +253,9 @@ def __init__(self, *args):
 
     def setMode(self, mode):
         """
-        .. py:method:: setMode(mode)
-
-            Set the mode of the color map
-            
-            :param int mode: :py:data:`QwtLinearColorMap.FixedColors` or :py:data:`QwtLinearColorMap.ScaledColors`
+        Set the mode of the color map
+        
+        :param int mode: :py:data:`QwtLinearColorMap.FixedColors` or :py:data:`QwtLinearColorMap.ScaledColors`
 
         `FixedColors` means the color is calculated from the next lower color 
         stop. `ScaledColors` means the color is calculated by interpolating 
@@ -271,7 +265,7 @@ def setMode(self, mode):
 
     def mode(self):
         """
-        Return the mode of the color map
+        :return: the mode of the color map
         
         .. seealso ::
             
@@ -343,19 +337,17 @@ def __init__(self, color):
 
     def setColor(self, color):
         """
-        .. py:method:: setColor(color)
-
-            Set the color of the map
-            
-            :param QColor color: color of the map
+        Set the color of the map
+        
+        :param QColor color: color of the map
         """
         self.__data.color = color
         self.__data.rgb = color.rgb() & qRgba(255, 255, 255, 0)
         self.__data.rgbMax = self.__data.rgb | ( 255 << 24 )
 
     def color(self):
         """
-        Return the color of the map
+        :return: the color of the map
         
         .. seealso ::
             

qwt/graphic.py

@@ -250,7 +250,7 @@ class QwtGraphic(QwtNullPaintDevice):
     
         Copy constructor
         
-        :param: QwtGraphic other: Source
+        :param qwt.graphic.QwtGraphic other: Source
     """
 
     # enum RenderHint
@@ -298,13 +298,11 @@ def testRenderHint(self, hint):
 
     def boundingRect(self):
         """
-        .. py:method:: boundingRect()
+        The bounding rectangle is the :py:meth:`controlPointRect`
+        extended by the areas needed for rendering the outlines
+        with unscaled pens.
 
-            The bounding rectangle is the :py:meth:`controlPointRect`
-            extended by the areas needed for rendering the outlines
-            with unscaled pens.
-
-            :return: Bounding rectangle of the graphic
+        :return: Bounding rectangle of the graphic
         
         .. seealso::
             
@@ -316,13 +314,11 @@ def boundingRect(self):
 
     def controlPointRect(self):
         """
-        .. py:method:: controlPointRect()
-
-            The control point rectangle is the bounding rectangle 
-            of all control points of the paths and the target
-            rectangles of the images/pixmaps.
+        The control point rectangle is the bounding rectangle 
+        of all control points of the paths and the target
+        rectangles of the images/pixmaps.
 
-            :return: Control point rectangle
+        :return: Control point rectangle
         
         .. seealso::
         
@@ -334,13 +330,11 @@ def controlPointRect(self):
 
     def scaledBoundingRect(self, sx, sy):
         """
-        .. py:method:: scaledBoundingRect(sx, sy)
+        Calculate the target rectangle for scaling the graphic
         
-            Calculate the target rectangle for scaling the graphic
-            
-            :param: float sx: Horizontal scaling factor 
-            :param: float sy: Vertical scaling factor 
-            :return: Scaled bounding rectangle
+        :param float sx: Horizontal scaling factor 
+        :param float sy: Vertical scaling factor 
+        :return: Scaled bounding rectangle
             
         .. note::
         
@@ -369,14 +363,12 @@ def sizeMetrics(self):
 
     def setDefaultSize(self, size):
         """
-        .. py:method:: setDefaultSize(size)
+        The default size is used in all methods rendering the graphic,
+        where no size is explicitly specified. Assigning an empty size
+        means, that the default size will be calculated from the bounding 
+        rectangle.
         
-            The default size is used in all methods rendering the graphic,
-            where no size is explicitly specified. Assigning an empty size
-            means, that the default size will be calculated from the bounding 
-            rectangle.
-            
-            :param: QSizeF size: Default size
+        :param QSizeF size: Default size
 
         .. seealso::
         
@@ -388,16 +380,14 @@ def setDefaultSize(self, size):
 
     def defaultSize(self):
         """
-        .. py:method:: defaultSize()
-        
-            When a non empty size has been assigned by setDefaultSize() this
-            size will be returned. Otherwise the default size is the size
-            of the bounding rectangle.
+        When a non empty size has been assigned by setDefaultSize() this
+        size will be returned. Otherwise the default size is the size
+        of the bounding rectangle.
 
-            The default size is used in all methods rendering the graphic,
-            where no size is explicitly specified. 
-            
-            :return: Default size
+        The default size is used in all methods rendering the graphic,
+        where no size is explicitly specified. 
+        
+        :return: Default size
 
         .. seealso::
         
@@ -413,7 +403,7 @@ def render(self, *args):
         
             Replay all recorded painter commands
             
-            :param: QPainter painter: Qt painter
+            :param QPainter painter: Qt painter
         
         .. py:method:: render(painter, size, aspectRatioMode)
         
@@ -422,19 +412,19 @@ def render(self, *args):
             The graphic is scaled to fit into the rectangle
             of the given size starting at ( 0, 0 ).
             
-            :param: QPainter painter: Qt painter
-            :param: QSizeF size: Size for the scaled graphic
-            :param: Qt.AspectRatioMode aspectRatioMode: Mode how to scale
+            :param QPainter painter: Qt painter
+            :param QSizeF size: Size for the scaled graphic
+            :param Qt.AspectRatioMode aspectRatioMode: Mode how to scale
         
         .. py:method:: render(painter, rect, aspectRatioMode)
         
             Replay all recorded painter commands
             
             The graphic is scaled to fit into the given rectangle
             
-            :param: QPainter painter: Qt painter
-            :param: QRectF rect: Rectangle for the scaled graphic
-            :param: Qt.AspectRatioMode aspectRatioMode: Mode how to scale        
+            :param QPainter painter: Qt painter
+            :param QRectF rect: Rectangle for the scaled graphic
+            :param Qt.AspectRatioMode aspectRatioMode: Mode how to scale        
         
         .. py:method:: render(painter, pos, aspectRatioMode)
         
@@ -443,9 +433,9 @@ def render(self, *args):
             The graphic is scaled to the :py:meth:`defaultSize()` and aligned
             to a position.
             
-            :param: QPainter painter: Qt painter
-            :param: QPointF pos: Reference point, where to render
-            :param: Qt.AspectRatioMode aspectRatioMode: Mode how to scale        
+            :param QPainter painter: Qt painter
+            :param QPointF pos: Reference point, where to render
+            :param Qt.AspectRatioMode aspectRatioMode: Mode how to scale        
         """
         if len(args) == 1:
             painter, = args
@@ -536,17 +526,15 @@ def render(self, *args):
 
     def toPixmap(self, *args):
         """
-        .. py:method:: toPixmap()
-        
-            Convert the graphic to a `QPixmap`
+        Convert the graphic to a `QPixmap`
 
-            All pixels of the pixmap get initialized by `Qt.transparent`
-            before the graphic is scaled and rendered on it.
+        All pixels of the pixmap get initialized by `Qt.transparent`
+        before the graphic is scaled and rendered on it.
 
-            The size of the pixmap is the default size ( ceiled to integers )
-            of the graphic.
-            
-            :return: The graphic as pixmap in default size
+        The size of the pixmap is the default size ( ceiled to integers )
+        of the graphic.
+        
+        :return: The graphic as pixmap in default size
 
         .. seealso::
         
@@ -603,8 +591,8 @@ def toImage(self, *args):
 
             The format of the image is `QImage.Format_ARGB32_Premultiplied`.
             
-            :param: QSize size: Size of the image
-            :param: `Qt.AspectRatioMode` aspectRatioMode: Aspect ratio how to scale the graphic
+            :param QSize size: Size of the image
+            :param `Qt.AspectRatioMode` aspectRatioMode: Aspect ratio how to scale the graphic
             :return: The graphic as image
 
         .. seealso::
@@ -638,11 +626,9 @@ def toImage(self, *args):
 
     def drawPath(self, path):
         """
-        .. py:method:: drawPath(path)
+        Store a path command in the command list
         
-            Store a path command in the command list
-            
-            :param: QPainterPath path: Painter path
+        :param QPainterPath path: Painter path
 
         .. seealso::
         
@@ -666,13 +652,11 @@ def drawPath(self, path):
 
     def drawPixmap(self, rect, pixmap, subRect):
         """
-        .. py:method:: drawPixmap(rect, pixmap, subRect)
+        Store a pixmap command in the command list
         
-            Store a pixmap command in the command list
-            
-            :param: QRectF rect: target rectangle
-            :param: QPixmap pixmap: Pixmap to be painted
-            :param: QRectF subRect: Reactangle of the pixmap to be painted
+        :param QRectF rect: target rectangle
+        :param QPixmap pixmap: Pixmap to be painted
+        :param QRectF subRect: Reactangle of the pixmap to be painted
 
         .. seealso::
         
@@ -688,14 +672,12 @@ def drawPixmap(self, rect, pixmap, subRect):
 
     def drawImage(self, rect, image, subRect, flags):
         """
-        .. py:method:: drawImage(rect, image, subRect, flags)
+        Store a image command in the command list
         
-            Store a image command in the command list
-            
-            :param: QRectF rect: target rectangle
-            :param: QImage image: Pixmap to be painted
-            :param: QRectF subRect: Reactangle of the pixmap to be painted
-            :param: Qt.ImageConversionFlags flags: Pixmap to be painted
+        :param QRectF rect: target rectangle
+        :param QImage image: Pixmap to be painted
+        :param QRectF subRect: Reactangle of the pixmap to be painted
+        :param Qt.ImageConversionFlags flags: Pixmap to be painted
 
         .. seealso::
         
@@ -711,11 +693,9 @@ def drawImage(self, rect, image, subRect, flags):
 
     def updateState(self, state):
         """
-        .. py:method:: updateState(state)
+        Store a state command in the command list
         
-            Store a state command in the command list
-            
-            :param: QPaintEngineState state: State to be stored
+        :param QPaintEngineState state: State to be stored
 
         .. seealso::