Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Some docstring additions, reformats and epydoc markup.

Browse Source 
Removed RefDoc macros, instead made all the normal Docstring macros
take an extra parameter to be used for the optional details postion of
the docstring.  The intent is that the docstrings put in the generated
.py files checked in to CVS and delivered in releases will be only a
paragraph or two, but when used for generating the epydoc reference
docs they can optionally contain a lot more details.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@27216 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2004-05-12 00:17:48 +00:00
parent 0b9c95225e
commit d07d2bc9d0
41 changed files with 1657 additions and 1537 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
wxPython/src/_artprov.i
View File

@@ -122,7 +122,7 @@ method and register the provider with wx.ArtProvider.PushProvider::
def CreateBitmap(self, artid, client, size):
...
return bmp
", "
Identifying art resources
-------------------------
@@ -197,18 +197,18 @@ public:
DocDeclStr(
static void , PushProvider(wxPyArtProvider *provider),
"Add new provider to the top of providers stack.");
"Add new provider to the top of providers stack.", "");
DocDeclStr(
static bool , PopProvider(),
"Remove latest added provider and delete it.");
"Remove latest added provider and delete it.", "");
DocDeclStr(
static bool , RemoveProvider(wxPyArtProvider *provider),
"Remove provider. The provider must have been added previously! The
provider is _not_ deleted.");
provider is _not_ deleted.", "");
DocDeclStr(
@@ -216,7 +216,7 @@ provider is _not_ deleted.");
const wxString& client = wxPyART_OTHER,
const wxSize& size = wxDefaultSize),
"Query the providers for bitmap with given ID and return it. Return
wx.NullBitmap if no provider provides it.");
wx.NullBitmap if no provider provides it.", "");
DocDeclStr(
@@ -224,7 +224,7 @@ wx.NullBitmap if no provider provides it.");
const wxString& client = wxPyART_OTHER,
const wxSize& size = wxDefaultSize),
"Query the providers for icon with given ID and return it. Return
wx.NullIcon if no provider provides it.");
wx.NullIcon if no provider provides it.", "");
%extend { void Destroy() { delete self; }}