Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

use @deprecated doxygen tag, a few other minor corrections (#9564)

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54178 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2008-06-13 00:05:15 +00:00
parent 75b00cf87d
commit 5dfae0ada3
2 changed files with 14 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
interface/menu.h
View File

@@ -452,7 +452,7 @@ public:
/** /**
Adds a submenu. Adds a submenu.
@warning This function is deprecated, use AppendSubMenu() instead. @deprecated This function is deprecated, use AppendSubMenu() instead.
@param id @param id
The menu command identifier. The menu command identifier.
@@ -802,25 +802,25 @@ public:
/** /**
Removes the menu item from the menu but doesn't delete the associated C++ Removes the menu item from the menu but doesn't delete the associated C++
object. This allows to reuse the same item later by adding it back to the menu object. This allows you to reuse the same item later by adding it back to the menu
(especially useful with submenus). (especially useful with submenus).
@param id @param id
The identifier of the menu item to remove. The identifier of the menu item to remove.
@return The item which was detached from the menu. @return A pointer to the item which was detached from the menu.
*/ */
wxMenuItem* Remove(int id); wxMenuItem* Remove(int id);
/** /**
Removes the menu item from the menu but doesn't delete the associated C++ Removes the menu item from the menu but doesn't delete the associated C++
object. This allows to reuse the same item later by adding it back to the menu object. This allows you to reuse the same item later by adding it back to the menu
(especially useful with submenus). (especially useful with submenus).
@param item @param item
The menu item to remove. The menu item to remove.
@return The item which was detached from the menu. @return A pointer to the item which was detached from the menu.
*/ */
wxMenuItem* Remove(wxMenuItem* item); wxMenuItem* Remove(wxMenuItem* item);

25
interface/menuitem.h
View File

@@ -29,9 +29,8 @@ public:
Constructs a wxMenuItem object. 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 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 on, see @ref page_stockitems "Stock Items" for the full list) it is enough
to to specify just the stock ID and leave @a text and @a helpString empty. In
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 fact, leaving at least @a text empty for the stock menu items is strongly
recommended as they will have appearance and keyboard interface (including recommended as they will have appearance and keyboard interface (including
standard accelerators) familiar to the user. standard accelerators) familiar to the user.
@@ -40,9 +39,7 @@ public:
description (which is automatically shown by the library in the status bar when description (which is automatically shown by the library in the status bar when
the menu item is selected) in this parameter. the menu item is selected) in this parameter.
Finally note that you can e.g. use a stock menu label without using its stock Finally note that you can e.g. use a stock menu label without using its stock
help string: help string; that is, stock properties are set independently one from the other.
that is, stock properties are set independently one from the other.
@param parentMenu @param parentMenu
Menu that the menu item belongs to. Menu that the menu item belongs to.
@@ -133,15 +130,13 @@ public:
/** /**
Returns the text associated with the menu item without any accelerator Returns the text associated with the menu item without any accelerator
characters it might contain. characters it might contain.
This function is deprecated in favour of GetItemLabelText(). @deprecated This function is deprecated in favour of GetItemLabelText().
@see GetText(), GetLabelFromText() @see GetText(), GetLabelFromText()
*/ */
wxString GetLabel() const; wxString GetLabel() const;
/** /**
This function is deprecated; please use GetLabelText() instead. @deprecated This function is deprecated; please use GetLabelText() instead.
@see GetText(), GetLabel() @see GetText(), GetLabel()
*/ */
static wxString GetLabelFromText(const wxString& text); static wxString GetLabelFromText(const wxString& text);
@@ -173,9 +168,8 @@ public:
/** /**
Returns the text associated with the menu item. Returns the text associated with the menu item.
@note this function is deprecated, please use @deprecated This function is deprecated. Please use
GetItemLabel() or GetItemLabelText() GetItemLabel() or GetItemLabelText() instead.
instead.
*/ */
wxString GetName() const; wxString GetName() const;
@@ -187,8 +181,7 @@ public:
/** /**
Returns the text associated with the menu item, such as it was passed to the 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. 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() @see GetLabel(), GetLabelFromText()
*/ */
wxString GetText() const; wxString GetText() const;
@@ -274,7 +267,7 @@ public:
/** /**
Sets the text associated with the menu item. 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); void SetText(const wxString& text);