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:
@@ -98,7 +98,7 @@ public:
|
||||
DocDeclAStr(
|
||||
virtual void, GetScrollPixelsPerUnit(int *OUTPUT, int *OUTPUT) const,
|
||||
"GetScrollPixelsPerUnit() -> (xUnit, yUnit)",
|
||||
"Get the size of one logical unit in physical units.");
|
||||
"Get the size of one logical unit in physical units.", "");
|
||||
|
||||
// Enable/disable Windows scrolling in either direction. If True, wxWindows
|
||||
// scrolls the canvas and only a bit of the canvas is invalidated; no
|
||||
@@ -111,7 +111,7 @@ public:
|
||||
DocDeclAStr(
|
||||
virtual void, GetViewStart(int *OUTPUT, int *OUTPUT) const,
|
||||
"GetViewStart() -> (x,y)",
|
||||
"Get the view start");
|
||||
"Get the view start", "");
|
||||
|
||||
// Set the scale factor, used in PrepareDC
|
||||
void SetScale(double xs, double ys);
|
||||
@@ -122,14 +122,14 @@ public:
|
||||
%nokwargs CalcScrolledPosition;
|
||||
%nokwargs CalcUnscrolledPosition;
|
||||
|
||||
DocStr(CalcScrolledPosition, "Translate between scrolled and unscrolled coordinates.");
|
||||
DocStr(CalcScrolledPosition, "Translate between scrolled and unscrolled coordinates.", "");
|
||||
wxPoint CalcScrolledPosition(const wxPoint& pt) const;
|
||||
DocDeclA(
|
||||
void, CalcScrolledPosition(int x, int y, int *OUTPUT, int *OUTPUT) const,
|
||||
"CalcScrolledPosition(int x, int y) -> (sx, sy)");
|
||||
|
||||
|
||||
DocStr(CalcUnscrolledPosition, "Translate between scrolled and unscrolled coordinates.");
|
||||
DocStr(CalcUnscrolledPosition, "Translate between scrolled and unscrolled coordinates.", "");
|
||||
wxPoint CalcUnscrolledPosition(const wxPoint& pt) const;
|
||||
DocDeclA(
|
||||
void, CalcUnscrolledPosition(int x, int y, int *OUTPUT, int *OUTPUT) const,
|
||||
|
Reference in New Issue
Block a user