no real changes, clarified the usage of WX_GL_DOUBLEBUFFER; documented it and other...

[wxWidgets.git] / interface / menuitem.h

diff --git a/interface/menuitem.h b/interface/menuitem.h
index a2762af1b2a6970cfe8321306bf128f03122d723..9296ab2ba39703f233cc8a7fe9dad8c07baf9910 100644 (file)
--- a/interface/menuitem.h
+++ b/interface/menuitem.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        menuitem.h
-// Purpose:     documentation for wxMenuItem class
+// Purpose:     interface of wxMenuItem
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -20,15 +20,14 @@
     @library{wxcore}
     @category{menus}
 
-    @seealso
-    wxMenuBar, wxMenu
+    @see wxMenuBar, wxMenu
 */
 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
@@ -42,16 +41,17 @@ public:
         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.
-        
+
         @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.
@@ -111,7 +111,7 @@ public:
     /**
         Returns the text associated with the menu item including any accelerator
         characters that were passed to the constructor or SetItemLabel.
-        
+
         @see GetItemLabelText(), GetLabelText()
     */
     wxString GetItemLabel() const;
@@ -119,7 +119,7 @@ public:
     /**
         Returns the text associated with the menu item, without any accelerator
         characters.
-        
+
         @see GetItemLabel(), GetLabelText()
     */
     wxString GetItemLabelText() const;
@@ -134,7 +134,7 @@ public:
         Returns the text associated with the menu item without any accelerator
         characters it might contain.
         This function is deprecated in favour of GetItemLabelText().
-        
+
         @see GetText(), GetLabelFromText()
     */
     wxString GetLabel() const;
@@ -142,10 +142,10 @@ public:
     /**
         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.
-        
+
         @see GetText(), GetLabel()
     */
     static wxString GetLabelFromText(const wxString& text);
@@ -153,9 +153,9 @@ public:
     /**
         Strips all accelerator characters and mnemonics from the given @e text.
         For example,
-        
+
         will return just @c "Hello".
-        
+
         @see GetItemLabelText(), GetItemLabel()
     */
     static wxString GetLabelText(const wxString& text);
@@ -173,7 +173,7 @@ public:
 
     /**
         Returns the text associated with the menu item.
-        @b NB: this function is deprecated, please use
+        @note this function is deprecated, please use
         GetItemLabel() or GetItemLabelText()
         instead.
     */
@@ -188,7 +188,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().
-        
+
         @see GetLabel(), GetLabelFromText()
     */
     wxString GetText() const;
@@ -283,3 +283,4 @@ public:
     */
     void SetTextColour(const wxColour& colour);
 };
+