mac paths updated

[wxWidgets.git] / interface / menuitem.h

diff --git a/interface/menuitem.h b/interface/menuitem.h
index e8604c2a537ea4391dc1c1685f35635d8393cb89..ba0905efd2b01b62ed73ae12b67f875b295cc6c1 100644 (file)
--- a/interface/menuitem.h
+++ b/interface/menuitem.h
@@ -27,11 +27,10 @@ class wxMenuItem : public wxObject
 public:
     /**
         Constructs a wxMenuItem object.
-        Menu items can be standard, or "stock menu items'', or custom. For the
+        Menu items can be standard, or "stock menu items", or custom. For the
         standard menu items (such as commands to open a file, exit the program and so
-        on, see @ref overview_stockitems "stock items" for the full list) it is enough
-        to
-        specify just the stock ID and leave @a text and @a helpString empty. In
+        on, see @ref page_stockitems "Stock Items" for the full list) it is enough
+        to specify just the stock ID and leave @a text and @a helpString empty. In
         fact, leaving at least @a text empty for the stock menu items is strongly
         recommended as they will have appearance and keyboard interface (including
         standard accelerators) familiar to the user.
@@ -40,17 +39,16 @@ public:
         description (which is automatically shown by the library in the status bar when
         the menu item is selected) in this parameter.
         Finally note that you can e.g. use a stock menu label without using its stock
-        help string:
-
-        that is, stock properties are set independently one from the other.
+        help string; that is, stock properties are set independently one from the other.
 
         @param parentMenu
             Menu that the menu item belongs to.
         @param id
-            Identifier for this menu item, or wxID_SEPARATOR to indicate a separator.
+            Identifier for this menu item. May be wxID_SEPARATOR, in which case the
+            given kind is ignored and taken to be wxITEM_SEPARATOR instead.
         @param text
             Text for the menu item, as shown on the menu. An accelerator
-            key can be specified using the ampersand '' character. In order to embed an
+            key can be specified using the ampersand " character. In order to embed an
             ampersand character in the menu item text, the ampersand must be doubled.
         @param helpString
             Optional help string that will be shown on the status bar.
@@ -132,26 +130,24 @@ public:
     /**
         Returns the text associated with the menu item without any accelerator
         characters it might contain.
-        This function is deprecated in favour of GetItemLabelText().
-
+        @deprecated This function is deprecated in favour of GetItemLabelText().
         @see GetText(), GetLabelFromText()
     */
     wxString GetLabel() const;
 
     /**
-        Strips all accelerator characters and mnemonics from the given @e text.
-        For example,
-
-        will return just @c "Hello".
-        This function is deprecated; please use GetLabelText() instead.
-
+        @deprecated This function is deprecated; please use GetLabelText() instead.
         @see GetText(), GetLabel()
     */
     static wxString GetLabelFromText(const wxString& text);
 
     /**
         Strips all accelerator characters and mnemonics from the given @e text.
-        For example,
+        For example:
+
+        @code
+          wxMenuItem::GetLabelfromText( "&Hello\tCtrl-h");
+        @endcode
 
         will return just @c "Hello".
 
@@ -172,9 +168,8 @@ public:
 
     /**
         Returns the text associated with the menu item.
-        @note this function is deprecated, please use
-        GetItemLabel() or GetItemLabelText()
-        instead.
+        @deprecated This function is deprecated. Please use
+        GetItemLabel() or GetItemLabelText() instead.
     */
     wxString GetName() const;
 
@@ -186,8 +181,7 @@ public:
     /**
         Returns the text associated with the menu item, such as it was passed to the
         wxMenuItem constructor, i.e. with any accelerator characters it may contain.
-        This function is deprecated in favour of GetItemLabel().
-
+        @deprecated This function is deprecated in favour of GetItemLabel().
         @see GetLabel(), GetLabelFromText()
     */
     wxString GetText() const;
@@ -273,7 +267,7 @@ public:
 
     /**
         Sets the text associated with the menu item.
-        This function is deprecated in favour of SetItemLabel().
+        @deprecated This function is deprecated in favour of SetItemLabel().
     */
     void SetText(const wxString& text);