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

66
wxPython/src/_display.i
View File

@@ -25,7 +25,7 @@
DocStr(wxVideoMode,
"A simple struct containing video mode parameters for a display");
"A simple struct containing video mode parameters for a display", "");
struct wxVideoMode
{
@@ -34,29 +34,28 @@ struct wxVideoMode
DocDeclStr(
bool , Matches(const wxVideoMode& other) const,
"Returns true if this mode matches the other one in the sense that
all non zero fields of the other mode have the same value in this
one (except for refresh which is allowed to have a greater value)");
"Returns true if this mode matches the other one in the sense that all
non zero fields of the other mode have the same value in this
one (except for refresh which is allowed to have a greater value)", "");
DocDeclStr(
int , GetWidth() const,
"Returns the screen width in pixels (e.g. 640*480), 0 means
unspecified");
"Returns the screen width in pixels (e.g. 640*480), 0 means unspecified", "");
DocDeclStr(
int , GetHeight() const,
"Returns the screen width in pixels (e.g. 640*480), 0 means
unspecified");
unspecified", "");
DocDeclStr(
int , GetDepth() const,
"Returns the screen's bits per pixel (e.g. 32), 1 is monochrome
and 0 means unspecified/known");
"Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0
means unspecified/known", "");
DocDeclStr(
bool , IsOk() const,
"returns true if the object has been initialized");
"returns true if the object has been initialized", "");
@@ -86,7 +85,7 @@ const wxVideoMode wxDefaultVideoMode;
//---------------------------------------------------------------------------
DocStr(wxDisplay,
"Represents a display/monitor attached to the system");
"Represents a display/monitor attached to the system", "");
class wxDisplay
@@ -95,26 +94,26 @@ public:
//
DocCtorStr(
wxDisplay(size_t index = 0),
"Set up a Display instance with the specified display. The
displays are numbered from 0 to GetCount() - 1, 0 is always the
primary display and the only one which is always supported");
"Set up a Display instance with the specified display. The displays
are numbered from 0 to GetCount() - 1, 0 is always the primary display
and the only one which is always supported", "");
virtual ~wxDisplay();
DocDeclStr(
static size_t , GetCount(),
"Return the number of available displays.");
"Return the number of available displays.", "");
DocDeclStr(
static int , GetFromPoint(const wxPoint& pt),
"Find the display where the given point lies, return wx.NOT_FOUND
if it doesn't belong to any display");
"Find the display where the given point lies, return wx.NOT_FOUND if it
doesn't belong to any display", "");
DocStr(GetFromWindow,
"Find the display where the given window lies, return wx.NOT_FOUND
if it is not shown at all.");
"Find the display where the given window lies, return wx.NOT_FOUND if
it is not shown at all.", "");
#ifdef __WXMSW__
static int GetFromWindow(wxWindow *window);
#else
@@ -126,39 +125,38 @@ if it is not shown at all.");
DocDeclStr(
virtual bool , IsOk() const,
"Return true if the object was initialized successfully");
"Return true if the object was initialized successfully", "");
%pythoncode { def __nonzero__(self): return self.IsOk() }
DocDeclStr(
virtual wxRect , GetGeometry() const,
"Returns the bounding rectangle of the display whose index was
passed to the constructor.");
"Returns the bounding rectangle of the display whose index was passed
to the constructor.", "");
DocDeclStr(
virtual wxString , GetName() const,
"Returns the display's name. A name is not available on all platforms.");
"Returns the display's name. A name is not available on all platforms.", "");
DocDeclStr(
bool , IsPrimary() const,
"Returns true if the display is the primary display. The primary
display is the one whose index is 0.");
display is the one whose index is 0.", "");
%extend {
DocAStr(GetModes,
"GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...]",
"Enumerate all video modes supported by this display matching the
given one (in the sense of VideoMode.Match()).
"Enumerate all video modes supported by this display matching the given
one (in the sense of VideoMode.Match()).
As any mode matches the default value of the argument and there
is always at least one video mode supported by display, the
returned array is only empty for the default value of the
argument if this function is not supported at all on this
platform.");
As any mode matches the default value of the argument and there is
always at least one video mode supported by display, the returned
array is only empty for the default value of the argument if this
function is not supported at all on this platform.", "");
PyObject* GetModes(const wxVideoMode& mode = wxDefaultVideoMode) {
PyObject* pyList = NULL;
@@ -178,17 +176,17 @@ platform.");
DocDeclStr(
virtual wxVideoMode , GetCurrentMode() const,
"Get the current video mode.");
"Get the current video mode.", "");
DocDeclStr(
virtual bool , ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode),
"Change current mode, return true if succeeded, false otherwise");
"Change current mode, return true if succeeded, false otherwise", "");
DocDeclStr(
void , ResetMode(),
"Restore the default video mode (just a more readable synonym)");
"Restore the default video mode (just a more readable synonym)", "");
};