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:
@@ -118,9 +118,11 @@ public:
|
||||
DocDeclAStr(
|
||||
virtual wxTreeItemId, FindChild(wxTreeItemId parentId, const wxString& path, bool& OUTPUT),
|
||||
"FindChild(wxTreeItemId parentId, wxString path) -> (item, done)",
|
||||
"Find the child that matches the first part of 'path'. E.g. if a child path is\n"
|
||||
"\"/usr\" and 'path' is \"/usr/include\" then the child for /usr is returned.\n"
|
||||
"If the path string has been used (we're at the leaf), done is set to True\n");
|
||||
"Find the child that matches the first part of 'path'. E.g. if a child
|
||||
path is \"/usr\" and 'path' is \"/usr/include\" then the child for
|
||||
/usr is returned. If the path string has been used (we're at the
|
||||
leaf), done is set to True.
|
||||
", "");
|
||||
|
||||
|
||||
// Resize the components of the control
|
||||
|
Reference in New Issue
Block a user