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

@@ -27,9 +27,7 @@ public:
//@{
/**
, @b wxWindow*@e parent = @NULL, @b int@e flags = @c wxICON_INFORMATION)
Create a notification object with the given attributes.
See SetTitle(),
SetMessage(),
SetParent() and
@@ -42,7 +40,6 @@ public:
/**
Hides the notification.
Returns @true if it was hidden or @false if it couldn't be done (e.g. on
some
systems automatically hidden notifications can't be hidden manually)
@@ -54,7 +51,6 @@ public:
notification. Valid values are @c wxICON_INFORMATION,
@c wxICON_WARNING and @c wxICON_ERROR (notice that
@c wxICON_QUESTION is not allowed here).
Some implementations of this class may not support the icons.
*/
void SetFlags(int flags);
@@ -83,10 +79,9 @@ public:
/**
Show the notification to the user and hides it after timeout seconds
pass. Special values @c Timeout_Auto and @c Timeout_Never can be
used here, notice that you shouldn't rely on @e timeout being exactly
used here, notice that you shouldn't rely on @a timeout being exactly
respected because the current platform may only support default timeout value
and also because the user may be able to close the notification.
Returns @false if an error occurred.
*/
bool Show(int timeout = Timeout_Auto);