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

@@ -35,21 +35,19 @@ public:
/**
Gets an option. The function is case-insensitive to @e name.
Returns empty string if the option hasn't been set.
@sa SetOption(), GetOptionInt(),
HasOption()
@see SetOption(), GetOptionInt(),
HasOption()
*/
wxString GetOption(const wxString& name);
/**
Gets an option as an integer. The function is case-insensitive to @e name.
If the option hasn't been set, this function returns 0.
@sa SetOption(), GetOption(),
HasOption()
@see SetOption(), GetOption(),
HasOption()
*/
int GetOptionInt(const wxString& name);
@@ -57,13 +55,13 @@ public:
Returns @true if the given option is present. The function is
case-insensitive to @e name.
@sa SetOption(), GetOption(),
GetOptionInt()
@see SetOption(), GetOption(),
GetOptionInt()
*/
bool HasOption(const wxString& name);
/**
Returns @true if the option with the given @e name had been set to 0
Returns @true if the option with the given @a name had been set to 0
value. This is mostly useful for boolean options for which you can't use
@c GetOptionInt(name) == 0 as this would also be @true if the option
hadn't been set at all.