]> git.saurik.com Git - wxWidgets.git/commitdiff
fix doxygen warnings
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Wed, 28 Jan 2009 00:51:55 +0000 (00:51 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Wed, 28 Jan 2009 00:51:55 +0000 (00:51 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58473 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/accel.h
interface/wx/event.h
interface/wx/kbdstate.h
interface/wx/listbox.h

index 2be0bdded11cc6700b698c950dbe7ff0245d45f7..e7d60861a5e6985ad22ec35ececdcfa444a44fba 100644 (file)
@@ -45,10 +45,10 @@ public:
         Constructor.
 
         @param flags
-            A combination of the wxAcceleratorEntryFlags values, which
+            A combination of the ::wxAcceleratorEntryFlags values, which
             indicates which modifier keys are held down.
         @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
             The menu or control command identifier (ID).
         @param item
@@ -86,10 +86,10 @@ public:
         Sets the accelerator entry parameters.
 
         @param flags
-            A combination of the wxAcceleratorEntryFlags values, which
+            A combination of the ::wxAcceleratorEntryFlags values, which
             indicates which modifier keys are held down.
         @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
             The menu or control command identifier (ID).
         @param item
@@ -104,6 +104,7 @@ public:
 
     /**
         Returns a wxString for this accelerator.
+
         This function formats it using the @c "flags-keycode" format
         where @c flags maybe a hyphen-separed list of @c "shift|alt|ctrl".
     */
index 7fa2d397e6c581e2ab0bc38a125cfe1b698ae139..238369e5336134e4887c1abf47a3a0f646280aa3 100644 (file)
@@ -748,7 +748,7 @@ public:
     Both key events provide untranslated key codes while the char event carries
     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
-    from the @ref page_keycodes.
+    from the ::wxKeyCode enumeration.
     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
     zone, for example.
@@ -818,7 +818,7 @@ public:
     /**
         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
-        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
         user entered a character that can be represented in current locale's default
index 45310d19c5f02cd2f2e51b9874725c8932dcde8b..8cfbb9841478d16a50976837c1c5d8494f6d1440 100644 (file)
     information about the modifier keys which were pressed when the event
     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.
 
     @category{misc}
+    @nolibrary
 
     @see wxKeyEvent, wxMouseState
  */
@@ -41,9 +42,9 @@ public:
         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
         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
-        wxMOD_META (Mac), see CmdDown(). See @ref page_keymodifiers for the
-        full list of modifiers.
+        and @c wxMOD_CMD is either @c wxMOD_CONTROL (MSW and Unix) or
+        @c wxMOD_META (Mac), see CmdDown().
+        See ::wxKeyModifier for the full list of modifiers.
 
         Notice that this function is easier to use correctly than, for example,
         ControlDown() because when using the latter you also have to remember to
index ea702f2381ece767c82698314c39273f5d444698..363f62471137c0a05e502802589f0ba469cae143 100644 (file)
@@ -171,7 +171,6 @@ public:
     */
     virtual int GetSelections(wxArrayInt& selections) const;
 
-    //@{
     /**
         Returns the item located at @a point, or @c wxNOT_FOUND if there
         is no item located at @a point.
@@ -187,8 +186,11 @@ public:
         @since 2.7.0
     */
     int HitTest(const wxPoint& point) const;
+
+    /**
+        @overload
+    */
     int HitTest(int x, int y) const;
-    //@}
 
     /**
         Insert the given number of strings before the specified position.