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,14 +27,13 @@ public:
Constructor.
@param flags
One of wxACCEL_ALT, wxACCEL_SHIFT, wxACCEL_CTRL and wxACCEL_NORMAL. Indicates
which modifier key is held down.
One of wxACCEL_ALT, wxACCEL_SHIFT, wxACCEL_CTRL and wxACCEL_NORMAL.
Indicates
which modifier key is held down.
@param keyCode
The keycode to be detected. See Keycodes for a full list of keycodes.
The keycode to be detected. See Keycodes for a full list of keycodes.
@param cmd
The menu or control command identifier.
The menu or control command identifier.
*/
wxAcceleratorEntry();
wxAcceleratorEntry(int flags, int keyCode, int cmd);
@@ -59,16 +58,15 @@ public:
Sets the accelerator entry parameters.
@param flags
One of wxACCEL_ALT, wxACCEL_SHIFT, wxACCEL_CTRL and wxACCEL_NORMAL. Indicates
which modifier key is held down.
One of wxACCEL_ALT, wxACCEL_SHIFT, wxACCEL_CTRL and wxACCEL_NORMAL.
Indicates
which modifier key is held down.
@param keyCode
The keycode to be detected. See Keycodes for a full list of keycodes.
The keycode to be detected. See Keycodes for a full list of keycodes.
@param cmd
The menu or control command identifier.
The menu or control command identifier.
*/
#define void Set(int flags, int keyCode, int cmd) /* implementation is private */
void Set(int flags, int keyCode, int cmd);
};
@@ -104,13 +102,11 @@ public:
Loads the accelerator table from a Windows resource (Windows only).
@param n
Number of accelerator entries.
Number of accelerator entries.
@param entries
The array of entries.
The array of entries.
@param resource
Name of a Windows accelerator.
Name of a Windows accelerator.
*/
wxAcceleratorTable();
wxAcceleratorTable(const wxAcceleratorTable& bitmap);
@@ -128,13 +124,13 @@ public:
/**
Returns @true if the accelerator table is valid.
*/
#define bool IsOk() /* implementation is private */
bool IsOk();
/**
Assignment operator, using @ref overview_trefcount "reference counting".
@param accel
Accelerator table to assign.
Accelerator table to assign.
*/
wxAcceleratorTable operator =(const wxAcceleratorTable& accel);
};