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:
@@ -204,7 +204,7 @@ public:
|
||||
DocDeclAStr(
|
||||
virtual void, GetSelection(long* OUTPUT, long* OUTPUT) const,
|
||||
"GetSelection() -> (from, to)",
|
||||
"If the return values from and to are the same, there is no selection.");
|
||||
"If the return values from and to are the same, there is no selection.", "");
|
||||
|
||||
virtual wxString GetStringSelection() const;
|
||||
|
||||
@@ -258,9 +258,8 @@ public:
|
||||
virtual wxTextCtrlHitTestResult, HitTest(const wxPoint& pt,
|
||||
long* OUTPUT, long* OUTPUT) const,
|
||||
"HitTest(Point pt) -> (result, row, col)",
|
||||
"Find the character at position given in pixels.\n"
|
||||
"NB: pt is in device coords (not adjusted for the client area\n"
|
||||
"origin nor scrolling)");
|
||||
"Find the character at position given in pixels. NB: pt is in device
|
||||
coords but is not adjusted for the client area origin nor scrolling", "");
|
||||
|
||||
|
||||
// Clipboard operations
|
||||
|
Reference in New Issue
Block a user