From 36e6f51a0f7fa77a24d23d588a6c354fa1238df4 Mon Sep 17 00:00:00 2001 From: Robin Dunn Date: Thu, 1 Mar 2007 22:00:29 +0000 Subject: [PATCH] Some docstring tweaks git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_8_BRANCH@44594 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- wxPython/src/_graphics.i | 14 ++++++++------ wxPython/src/gtk/_gdi.py | 14 +++++++++----- wxPython/src/mac/_gdi.py | 14 +++++++++----- wxPython/src/msw/_gdi.py | 14 +++++++++----- 4 files changed, 35 insertions(+), 21 deletions(-) diff --git a/wxPython/src/_graphics.i b/wxPython/src/_graphics.i index 90246393dd..8b667a7235 100644 --- a/wxPython/src/_graphics.i +++ b/wxPython/src/_graphics.i @@ -670,13 +670,15 @@ public: static wxGraphicsContext* , CreateFromNative( void * context ) , "Creates a wx.GraphicsContext from a native context. This native context must be eg a CGContextRef for Core Graphics, a Graphics -pointer for GDIPlus or a cairo_t pointer for Cairo.", ""); +pointer for GDIPlus or a cairo_t pointer for Cairo. NOTE: For +wxPython we still need a way to make this value usable.", ""); %newobject CreateFromNative; DocDeclStr( static wxGraphicsContext* , CreateFromNativeWindow( void * window ) , - "Creates a wx.GraphicsContext from a native window.", ""); + "Creates a wx.GraphicsContext from a native window. NOTE: For wxPython +we still need a way to make this value usable.", ""); @@ -799,8 +801,7 @@ this context.", ""); DocDeclStr( virtual wxGraphicsMatrix , GetTransform() const, "Gets the current transformation matrix of this context.", ""); - - + DocStr(SetPen, "Sets the stroke pen", ""); @@ -937,8 +938,9 @@ and the current brush is used for filling.", ""); %extend { - DocStr(StrokeLineSegements, - "Stroke disconnected lines from begin to end points", ""); + DocAStr(StrokeLineSegements, + "StrokeLineSegments(self, List beginPoints, List endPoints)", + "Stroke disconnected lines from begin to end points", ""); void StrokeLineSegements(PyObject* beginPoints, PyObject* endPoints) { size_t c1, c2, count; diff --git a/wxPython/src/gtk/_gdi.py b/wxPython/src/gtk/_gdi.py index a70a8ba74f..be7a5831bf 100644 --- a/wxPython/src/gtk/_gdi.py +++ b/wxPython/src/gtk/_gdi.py @@ -5391,7 +5391,8 @@ class GraphicsContext(GraphicsObject): Creates a wx.GraphicsContext from a native context. This native context must be eg a CGContextRef for Core Graphics, a Graphics - pointer for GDIPlus or a cairo_t pointer for Cairo. + pointer for GDIPlus or a cairo_t pointer for Cairo. NOTE: For + wxPython we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNative(*args, **kwargs) @@ -5400,7 +5401,8 @@ class GraphicsContext(GraphicsObject): """ CreateFromNativeWindow(void window) -> GraphicsContext - Creates a wx.GraphicsContext from a native window. + Creates a wx.GraphicsContext from a native window. NOTE: For wxPython + we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs) @@ -5719,7 +5721,7 @@ class GraphicsContext(GraphicsObject): def StrokeLineSegements(*args, **kwargs): """ - StrokeLineSegements(self, PyObject beginPoints, PyObject endPoints) + StrokeLineSegments(self, List beginPoints, List endPoints) Stroke disconnected lines from begin to end points """ @@ -5800,7 +5802,8 @@ def GraphicsContext_CreateFromNative(*args, **kwargs): Creates a wx.GraphicsContext from a native context. This native context must be eg a CGContextRef for Core Graphics, a Graphics - pointer for GDIPlus or a cairo_t pointer for Cairo. + pointer for GDIPlus or a cairo_t pointer for Cairo. NOTE: For + wxPython we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNative(*args, **kwargs) @@ -5808,7 +5811,8 @@ def GraphicsContext_CreateFromNativeWindow(*args, **kwargs): """ GraphicsContext_CreateFromNativeWindow(void window) -> GraphicsContext - Creates a wx.GraphicsContext from a native window. + Creates a wx.GraphicsContext from a native window. NOTE: For wxPython + we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs) diff --git a/wxPython/src/mac/_gdi.py b/wxPython/src/mac/_gdi.py index a322e52842..73f2bfaa85 100644 --- a/wxPython/src/mac/_gdi.py +++ b/wxPython/src/mac/_gdi.py @@ -5418,7 +5418,8 @@ class GraphicsContext(GraphicsObject): Creates a wx.GraphicsContext from a native context. This native context must be eg a CGContextRef for Core Graphics, a Graphics - pointer for GDIPlus or a cairo_t pointer for Cairo. + pointer for GDIPlus or a cairo_t pointer for Cairo. NOTE: For + wxPython we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNative(*args, **kwargs) @@ -5427,7 +5428,8 @@ class GraphicsContext(GraphicsObject): """ CreateFromNativeWindow(void window) -> GraphicsContext - Creates a wx.GraphicsContext from a native window. + Creates a wx.GraphicsContext from a native window. NOTE: For wxPython + we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs) @@ -5746,7 +5748,7 @@ class GraphicsContext(GraphicsObject): def StrokeLineSegements(*args, **kwargs): """ - StrokeLineSegements(self, PyObject beginPoints, PyObject endPoints) + StrokeLineSegments(self, List beginPoints, List endPoints) Stroke disconnected lines from begin to end points """ @@ -5827,7 +5829,8 @@ def GraphicsContext_CreateFromNative(*args, **kwargs): Creates a wx.GraphicsContext from a native context. This native context must be eg a CGContextRef for Core Graphics, a Graphics - pointer for GDIPlus or a cairo_t pointer for Cairo. + pointer for GDIPlus or a cairo_t pointer for Cairo. NOTE: For + wxPython we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNative(*args, **kwargs) @@ -5835,7 +5838,8 @@ def GraphicsContext_CreateFromNativeWindow(*args, **kwargs): """ GraphicsContext_CreateFromNativeWindow(void window) -> GraphicsContext - Creates a wx.GraphicsContext from a native window. + Creates a wx.GraphicsContext from a native window. NOTE: For wxPython + we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs) diff --git a/wxPython/src/msw/_gdi.py b/wxPython/src/msw/_gdi.py index 9d7fc06e6a..3bc5a7c2cd 100644 --- a/wxPython/src/msw/_gdi.py +++ b/wxPython/src/msw/_gdi.py @@ -5516,7 +5516,8 @@ class GraphicsContext(GraphicsObject): Creates a wx.GraphicsContext from a native context. This native context must be eg a CGContextRef for Core Graphics, a Graphics - pointer for GDIPlus or a cairo_t pointer for Cairo. + pointer for GDIPlus or a cairo_t pointer for Cairo. NOTE: For + wxPython we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNative(*args, **kwargs) @@ -5525,7 +5526,8 @@ class GraphicsContext(GraphicsObject): """ CreateFromNativeWindow(void window) -> GraphicsContext - Creates a wx.GraphicsContext from a native window. + Creates a wx.GraphicsContext from a native window. NOTE: For wxPython + we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs) @@ -5844,7 +5846,7 @@ class GraphicsContext(GraphicsObject): def StrokeLineSegements(*args, **kwargs): """ - StrokeLineSegements(self, PyObject beginPoints, PyObject endPoints) + StrokeLineSegments(self, List beginPoints, List endPoints) Stroke disconnected lines from begin to end points """ @@ -5925,7 +5927,8 @@ def GraphicsContext_CreateFromNative(*args, **kwargs): Creates a wx.GraphicsContext from a native context. This native context must be eg a CGContextRef for Core Graphics, a Graphics - pointer for GDIPlus or a cairo_t pointer for Cairo. + pointer for GDIPlus or a cairo_t pointer for Cairo. NOTE: For + wxPython we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNative(*args, **kwargs) @@ -5933,7 +5936,8 @@ def GraphicsContext_CreateFromNativeWindow(*args, **kwargs): """ GraphicsContext_CreateFromNativeWindow(void window) -> GraphicsContext - Creates a wx.GraphicsContext from a native window. + Creates a wx.GraphicsContext from a native window. NOTE: For wxPython + we still need a way to make this value usable. """ return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs)