Some docstring additions, reformats and epydoc markup.

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

View File

@@ -18,20 +18,20 @@
DocStr(wxObject,
"The base class for most wx objects, although in wxPython not
much functionality is needed nor exposed.");
much functionality is needed nor exposed.", "");
class wxObject {
public:
%extend {
DocStr(GetClassName,
"Returns the class name of the C++ class using wxRTTI.");
"Returns the class name of the C++ class using wxRTTI.", "");
wxString GetClassName() {
return self->GetClassInfo()->GetClassName();
}
DocStr(Destroy,
"Deletes the C++ object this Python object is a proxy for.");
"Deletes the C++ object this Python object is a proxy for.", "");
void Destroy() {
delete self;
}