docstring fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@32132 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/wxPython/src/_cursor.i b/wxPython/src/_cursor.i
index bcdda58f5457515d603043a59d976df8d1361aef..d929d41a707560249d323645cacc8a279146594c 100644 (file)
--- a/wxPython/src/_cursor.i
+++ b/wxPython/src/_cursor.i
@@ -72,7 +72,7 @@ public:
                "Construct a Cursor from a file.  Specify the type of file using
 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
 file.","
                "Construct a Cursor from a file.  Specify the type of file using
 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
 file.","

-:see: Alternate constructors `wx.StockCursor`,`wx.CursorFromImage`, `wx.CursorFromBits`");
+:see: Alternate constructors `wx.StockCursor`,`wx.CursorFromImage`");

         wxCursor(const wxString& cursorName, long type, int hotSpotX=0, int hotSpotY=0) {
 %#ifdef __WXGTK__
             wxImage img(cursorName, type);
         wxCursor(const wxString& cursorName, long type, int hotSpotX=0, int hotSpotY=0) {
 %#ifdef __WXGTK__
             wxImage img(cursorName, type);


@@ -97,7 +97,7 @@ stock cursors are available on all platforms.", "",
     DocCtorStrName(
         wxCursor(const wxImage& image),
         "Constructs a cursor from a `wx.Image`. The mask (if any) will be used
     DocCtorStrName(
         wxCursor(const wxImage& image),
         "Constructs a cursor from a `wx.Image`. The mask (if any) will be used

-as transparent.",
+for setting the transparent portions of the cursor.",

 "
 In MSW the cursor is resized to 32x32.
 
 "
 In MSW the cursor is resized to 32x32.
 

diff --git a/wxPython/src/_listctrl.i b/wxPython/src/_listctrl.i
index c5679fdc75d2b32552a89d6e96d6cea95609fa7a..48a9f0ac311f1f0e02bc0a705c81391c58b0b66f 100644 (file)
--- a/wxPython/src/_listctrl.i
+++ b/wxPython/src/_listctrl.i
@@ -650,7 +650,7 @@ public:
         long, HitTest(const wxPoint& point, int& OUTPUT),
         "HitTest(Point point) -> (item, where)",
         "Determines which item (if any) is at the specified point, giving
         long, HitTest(const wxPoint& point, int& OUTPUT),
         "HitTest(Point point) -> (item, where)",
         "Determines which item (if any) is at the specified point, giving

-details in the second return value (see wxLIST_HITTEST_... flags.)", "");
+details in the second return value (see wx.LIST_HITTEST flags.)", "");

 
     // Inserts an item, returning the index of the new item if successful,
     // -1 otherwise.
 
     // Inserts an item, returning the index of the new item if successful,
     // -1 otherwise.

diff --git a/wxPython/src/_splitter.i b/wxPython/src/_splitter.i
index 3282c4e43e7f0c85c83163c6deb8092d6fd305b1..f44305c477c9aef56c125c81c4580290299285d4 100644 (file)
--- a/wxPython/src/_splitter.i
+++ b/wxPython/src/_splitter.i
@@ -179,13 +179,13 @@ splitter window.  The child window is shown if it is currently hidden.", "");
                                        wxWindow *window2,
                                        int sashPosition = 0),
         "Initializes the left and right panes of the splitter window.  The
                                        wxWindow *window2,
                                        int sashPosition = 0),
         "Initializes the left and right panes of the splitter window.  The

-child windows are shown if they are currently hidden.",
-        "
+child windows are shown if they are currently hidden.","
+

     :param window1:       The left pane.
     :param window2:       The right pane.
     :param sashPosition:  The initial position of the sash. If this
                   value is positive, it specifies the size of the left
     :param window1:       The left pane.
     :param window2:       The right pane.
     :param sashPosition:  The initial position of the sash. If this
                   value is positive, it specifies the size of the left

-                  pane. If it is negative, it is absolute value gives
+                  pane. If it is negative, its absolute value gives

                   the size of the right pane. Finally, specify 0
                   (default) to choose the default position (half of
                   the total window width).
                   the size of the right pane. Finally, specify 0
                   (default) to choose the default position (half of
                   the total window width).


@@ -205,13 +205,13 @@ application should check that the window is not currently split using
                                          wxWindow *window2,
                                          int sashPosition = 0),
         "Initializes the top and bottom panes of the splitter window.  The
                                          wxWindow *window2,
                                          int sashPosition = 0),
         "Initializes the top and bottom panes of the splitter window.  The

-child windows are shown if they are currently hidden.",
-        "
+child windows are shown if they are currently hidden.","
+

     :param window1:       The top pane.
     :param window2:       The bottom pane.
     :param sashPosition:  The initial position of the sash. If this
                   value is positive, it specifies the size of the
     :param window1:       The top pane.
     :param window2:       The bottom pane.
     :param sashPosition:  The initial position of the sash. If this
                   value is positive, it specifies the size of the

-                  upper pane. If it is negative, it is absolute value
+                  upper pane. If it is negative, its absolute value

                   gives the size of the lower pane. Finally, specify 0
                   (default) to choose the default position (half of
                   the total window height).
                   gives the size of the lower pane. Finally, specify 0
                   (default) to choose the default position (half of
                   the total window height).


@@ -319,6 +319,7 @@ Example values:
              automaticaly resized.
     0.5      Both windows grow equally.
     1.0      Only left/top window grows.
              automaticaly resized.
     0.5      Both windows grow equally.
     1.0      Only left/top window grows.

+    ======= =======================================

 
 The default value of sash gravity is 0.0. That value is compatible
 with the previous (before gravity was introduced) behaviour of the 
 
 The default value of sash gravity is 0.0. That value is compatible
 with the previous (before gravity was introduced) behaviour of the 

diff --git a/wxPython/src/_window.i b/wxPython/src/_window.i
index 66932fa7cce6c8addac4248ec24ed25a3faee88e..18032eae1b0304b3fe5b88de8fbc35e1614c7a45 100644 (file)
--- a/wxPython/src/_window.i
+++ b/wxPython/src/_window.i
@@ -1677,8 +1677,8 @@ toplevel parent of the window.", "");
         "Physically scrolls the pixels in the window and move child windows
 accordingly.  Use this function to optimise your scrolling
 implementations, to minimise the area that must be redrawn. Note that
         "Physically scrolls the pixels in the window and move child windows
 accordingly.  Use this function to optimise your scrolling
 implementations, to minimise the area that must be redrawn. Note that

-it is rarely required to call this function from a user program.",
-"
+it is rarely required to call this function from a user program.","
+

     :param dx:   Amount to scroll horizontally.
 
     :param dy:   Amount to scroll vertically.
     :param dx:   Amount to scroll horizontally.
 
     :param dy:   Amount to scroll vertically.