]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/stockitem.h
mac paths updated
[wxWidgets.git] / interface / stockitem.h
index 3bcf0b2d087ba5f7e728687cf3c2916377bbbd33..61f958d3eeccd17e21ab1223c57a1924a3fc4ae9 100644 (file)
@@ -1,29 +1,31 @@
 /////////////////////////////////////////////////////////////////////////////
-    // Name:        stockitem.h
-    // Purpose:     documentation for global functions
-    // Author:      wxWidgets team
-    // RCS-ID:      $Id$
-    // Licence:     wxWindows license
-    /////////////////////////////////////////////////////////////////////////////
-    
-    /**
-    Returns label that should be used for given @e id element.
-    
-    @param id 
-    given id of the wxMenuItem, wxButton, wxToolBar tool, etc.
-    
-    @param withCodes 
-    if @false then strip accelerator code from the label;
-    useful for getting labels without accelerator char code like for toolbar
-    tooltip or
-    on platforms without traditional keyboard like smartphones
-    
-    @param accelerator 
-    optional accelerator string automatically added to label; useful
-    for building labels for wxMenuItem
+// Name:        stockitem.h
+// Purpose:     interface of global functions
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/** @ingroup group_funcmacro_misc */
+//@{
+
+/**
+    Returns label that should be used for given @a id element.
+
+    @param id
+        Given id of the wxMenuItem, wxButton, wxToolBar tool, etc.
+    @param withCodes
+        If @false then strip accelerator code from the label; useful for
+        getting labels without accelerator char code like for toolbar tooltip
+        or on platforms without traditional keyboard like smartphones.
+    @param accelerator
+        Optional accelerator string automatically added to label; useful for
+        building labels for wxMenuItem.
+
+    @header{wx/stockitem.h}
 */
-wxString wxGetStockLabel(wxWindowID id, bool withCodes = @true,
+wxString wxGetStockLabel(wxWindowID id, bool withCodes = true,
                          const wxString& accelerator = wxEmptyString);
 
+//@}
 
-    
\ No newline at end of file