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

Fix ribbon documentation warnings.

Browse Source 
See #15346.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74690 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Steve Lamerton
2013-08-21 15:21:08 +00:00
parent f54c646fb0
commit 2f36b4d22b
1 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
interface/wx/ribbon/toolbar.h
View File

@@ -325,7 +325,7 @@ public:
/** /**
Get any client data associated with the tool. Get any client data associated with the tool.
@param toolId @param tool_id
ID of the tool in question, as passed to AddTool(). ID of the tool in question, as passed to AddTool().
@return Client data, or @NULL if there is none. @return Client data, or @NULL if there is none.
@@ -337,7 +337,7 @@ public:
/** /**
Called to determine whether a tool is enabled (responds to user input). Called to determine whether a tool is enabled (responds to user input).
@param toolId @param tool_id
ID of the tool in question, as passed to AddTool(). ID of the tool in question, as passed to AddTool().
@return @true if the tool is enabled, @false otherwise. @return @true if the tool is enabled, @false otherwise.
@@ -351,7 +351,7 @@ public:
/** /**
Returns the help string for the given tool. Returns the help string for the given tool.
@param toolId @param tool_id
ID of the tool in question, as passed to AddTool(). ID of the tool in question, as passed to AddTool().
@since 2.9.4 @since 2.9.4
@@ -361,7 +361,7 @@ public:
/** /**
Return the kind of the given tool. Return the kind of the given tool.
@param toolId @param tool_id
ID of the tool in question, as passed to AddTool(). ID of the tool in question, as passed to AddTool().
@since 2.9.4 @since 2.9.4
@@ -372,7 +372,7 @@ public:
Returns the tool position in the toolbar, or @c wxNOT_FOUND if the tool Returns the tool position in the toolbar, or @c wxNOT_FOUND if the tool
is not found. is not found.
@param toolId @param tool_id
ID of the tool in question, as passed to AddTool(). ID of the tool in question, as passed to AddTool().
@since 2.9.4 @since 2.9.4
@@ -382,7 +382,7 @@ public:
/** /**
Gets the on/off state of a toggle tool. Gets the on/off state of a toggle tool.
@param toolId @param tool_id
ID of the tool in question, as passed to AddTool(). ID of the tool in question, as passed to AddTool().
@return @true if the tool is toggled on, @false otherwise. @return @true if the tool is toggled on, @false otherwise.
@@ -419,8 +419,10 @@ public:
/** /**
Sets the client data associated with the tool. Sets the client data associated with the tool.
@param id @param tool_id
ID of the tool in question, as passed to AddTool(). ID of the tool in question, as passed to AddTool().
@param clientData
The client data to use.
@since 2.9.4 @since 2.9.4
*/ */
@@ -432,6 +434,8 @@ public:
@param tool_id @param tool_id
ID of the tool in question, as passed to AddTool(). ID of the tool in question, as passed to AddTool().
@param bitmap
Bitmap to use for disabled tools.
@since 2.9.4 @since 2.9.4
*/ */
@@ -440,7 +444,7 @@ public:
/** /**
Sets the help string shown in tooltip for the given tool. Sets the help string shown in tooltip for the given tool.
@param tool_Id @param tool_id
ID of the tool in question, as passed to AddTool(). ID of the tool in question, as passed to AddTool().
@param helpString @param helpString
A string for the help. A string for the help.
@@ -456,6 +460,8 @@ public:
@param tool_id @param tool_id
ID of the tool in question, as passed to AddTool(). ID of the tool in question, as passed to AddTool().
@param bitmap
Bitmap to use for normals tools.
@since 2.9.4 @since 2.9.4
*/ */