added language info for Northern Sami (patch 1964036)

[wxWidgets.git] / interface / stockitem.h

diff --git a/interface/stockitem.h b/interface/stockitem.h
index d61fd0f90718ec21b49978a3457b662b819dca81..61f958d3eeccd17e21ab1223c57a1924a3fc4ae9 100644 (file)
--- a/interface/stockitem.h
+++ b/interface/stockitem.h
@@ -1,26 +1,31 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stockitem.h
-// Purpose:     documentation for global functions
+// 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.
+    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.
 
-@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,
                          const wxString& accelerator = wxEmptyString);
 
+//@}