fix doxygen warnings

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58473 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2009-01-28 00:51:55 +00:00
parent 99d8272073
commit d4624460ec
4 changed files with 16 additions and 12 deletions

View File

@@ -45,10 +45,10 @@ public:
Constructor. Constructor.
@param flags @param flags
A combination of the wxAcceleratorEntryFlags values, which A combination of the ::wxAcceleratorEntryFlags values, which
indicates which modifier keys are held down. indicates which modifier keys are held down.
@param keyCode @param keyCode
The keycode to be detected. See @ref page_keycodes for a full list of keycodes. The keycode to be detected. See ::wxKeyCode for a full list of keycodes.
@param cmd @param cmd
The menu or control command identifier (ID). The menu or control command identifier (ID).
@param item @param item
@@ -86,10 +86,10 @@ public:
Sets the accelerator entry parameters. Sets the accelerator entry parameters.
@param flags @param flags
A combination of the wxAcceleratorEntryFlags values, which A combination of the ::wxAcceleratorEntryFlags values, which
indicates which modifier keys are held down. indicates which modifier keys are held down.
@param keyCode @param keyCode
The keycode to be detected. See @ref page_keycodes for a full list of keycodes. The keycode to be detected. See ::wxKeyCode for a full list of keycodes.
@param cmd @param cmd
The menu or control command identifier (ID). The menu or control command identifier (ID).
@param item @param item
@@ -104,6 +104,7 @@ public:
/** /**
Returns a wxString for this accelerator. Returns a wxString for this accelerator.
This function formats it using the @c "flags-keycode" format This function formats it using the @c "flags-keycode" format
where @c flags maybe a hyphen-separed list of @c "shift|alt|ctrl". where @c flags maybe a hyphen-separed list of @c "shift|alt|ctrl".
*/ */

View File

@@ -748,7 +748,7 @@ public:
Both key events provide untranslated key codes while the char event carries Both key events provide untranslated key codes while the char event carries
the translated one. The untranslated code for alphanumeric keys is always the translated one. The untranslated code for alphanumeric keys is always
an upper case value. For the other keys it is one of @c WXK_XXX values an upper case value. For the other keys it is one of @c WXK_XXX values
from the @ref page_keycodes. from the ::wxKeyCode enumeration.
The translated key is, in general, the character the user expects to appear The translated key is, in general, the character the user expects to appear
as the result of the key combination when typing the text into a text entry as the result of the key combination when typing the text into a text entry
zone, for example. zone, for example.
@@ -818,7 +818,7 @@ public:
/** /**
Returns the virtual key code. ASCII events return normal ASCII values, Returns the virtual key code. ASCII events return normal ASCII values,
while non-ASCII events return values such as @b WXK_LEFT for the left cursor while non-ASCII events return values such as @b WXK_LEFT for the left cursor
key. See @ref page_keycodes for a full list of the virtual key codes. key. See ::wxKeyCode for a full list of the virtual key codes.
Note that in Unicode build, the returned value is meaningful only if the Note that in Unicode build, the returned value is meaningful only if the
user entered a character that can be represented in current locale's default user entered a character that can be represented in current locale's default

View File

@@ -15,10 +15,11 @@
information about the modifier keys which were pressed when the event information about the modifier keys which were pressed when the event
occurred. occurred.
This class is implemented entirely inline in @<wx/keystate.h@> and thus has This class is implemented entirely inline in @<wx/kbdstate.h@> and thus has
no linking requirements. no linking requirements.
@category{misc} @category{misc}
@nolibrary
@see wxKeyEvent, wxMouseState @see wxKeyEvent, wxMouseState
*/ */
@@ -41,9 +42,9 @@ public:
The return value is a combination of @c wxMOD_ALT, @c wxMOD_CONTROL, The return value is a combination of @c wxMOD_ALT, @c wxMOD_CONTROL,
@c wxMOD_SHIFT and @c wxMOD_META bit masks. Additionally, @c wxMOD_NONE @c wxMOD_SHIFT and @c wxMOD_META bit masks. Additionally, @c wxMOD_NONE
is defined as 0, i.e. corresponds to no modifiers (see HasModifiers()) is defined as 0, i.e. corresponds to no modifiers (see HasModifiers())
and @c wxMOD_CMD is either @c wxMOD_CONTROL (MSW and Unix) or @c and @c wxMOD_CMD is either @c wxMOD_CONTROL (MSW and Unix) or
wxMOD_META (Mac), see CmdDown(). See @ref page_keymodifiers for the @c wxMOD_META (Mac), see CmdDown().
full list of modifiers. See ::wxKeyModifier for the full list of modifiers.
Notice that this function is easier to use correctly than, for example, Notice that this function is easier to use correctly than, for example,
ControlDown() because when using the latter you also have to remember to ControlDown() because when using the latter you also have to remember to

View File

@@ -171,7 +171,6 @@ public:
*/ */
virtual int GetSelections(wxArrayInt& selections) const; virtual int GetSelections(wxArrayInt& selections) const;
//@{
/** /**
Returns the item located at @a point, or @c wxNOT_FOUND if there Returns the item located at @a point, or @c wxNOT_FOUND if there
is no item located at @a point. is no item located at @a point.
@@ -187,8 +186,11 @@ public:
@since 2.7.0 @since 2.7.0
*/ */
int HitTest(const wxPoint& point) const; int HitTest(const wxPoint& point) const;
/**
@overload
*/
int HitTest(int x, int y) const; int HitTest(int x, int y) const;
//@}
/** /**
Insert the given number of strings before the specified position. Insert the given number of strings before the specified position.