first revision (contains wxHelpEvent and wxNavigationKeyEvent modifications which...

[wxWidgets.git] / interface / stockitem.h

diff --git a/interface/stockitem.h b/interface/stockitem.h
index c02e77cc66a003e50a8f1e4b9ccafee70ee7dfc5..61f958d3eeccd17e21ab1223c57a1924a3fc4ae9 100644 (file)
--- a/interface/stockitem.h
+++ b/interface/stockitem.h
@@ -1,28 +1,31 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stockitem.h
-// Purpose:     documentation for global functions
+// Purpose:     interface of global functions
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-/**
-Returns label that should be used for given @e id element.
+/** @ingroup group_funcmacro_misc */
+//@{
 
-@param id
-given id of the wxMenuItem, wxButton, wxToolBar tool, etc.
+/**
+    Returns label that should be used for given @a id element.
 
-@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 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.
 
-@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);
 
+//@}