removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions

View File

@@ -60,16 +60,12 @@ public:
/**
Get the caret position (in pixels).
@b GetPosition()
Returns a Wx::Point
@b GetPositionXY()
Returns a 2-element list
@c ( x, y )
*/
@@ -81,16 +77,12 @@ public:
/**
Get the caret size.
@b GetSize()
Returns a Wx::Size
@b GetSizeWH()
Returns a 2-element list
@c ( width, height )
*/
@@ -111,7 +103,7 @@ public:
/**
Returns @true if the caret was created successfully.
*/
#define bool IsOk() /* implementation is private */
bool IsOk();
/**
Returns @true if the caret is visible and @false if it is permanently
@@ -132,10 +124,10 @@ public:
Sets the blink time for all the carets.
@remarks Under Windows, this function will change the blink time for all
carets permanently (until the next time it is
called), even for the carets in other applications.
carets permanently (until the next time it is called),
even for the carets in other applications.
@sa GetBlinkTime()
@see GetBlinkTime()
*/
static void SetBlinkTime(int milliseconds);
@@ -151,5 +143,5 @@ public:
Shows or hides the caret. Notice that if the caret was hidden N times, it
must be shown N times as well to reappear on the screen.
*/
void Show(bool show = @true);
void Show(bool show = true);
};