removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions

View File

@@ -11,7 +11,7 @@
@headerfile dockart.h wx/aui/dockart.h
wxAuiDockArt is part of the wxAUI class framework.
See also @ref overview_wxauioverview "wxAUI overview".
See also @ref overview_wxauioverview.
Dock art provider code - a dock provider provides all drawing
functionality to the wxAui dock manager. This allows the dock
@@ -75,10 +75,8 @@ public:
/**
Draws a button in the pane's title bar.
@e button can be one of the values of @b wxAuiButtonId.
@e button_state can be one of the values of @b wxAuiPaneButtonState.
@a button can be one of the values of @b wxAuiButtonId.
@a button_state can be one of the values of @b wxAuiPaneButtonState.
*/
virtual void DrawPaneButton(wxDC& dc, wxWindow* window,
int button,
@@ -100,8 +98,7 @@ public:
/**
Get the colour of a certain setting.
@e id can be one of the colour values of @b wxAuiPaneDockArtSetting.
@a id can be one of the colour values of @b wxAuiPaneDockArtSetting.
*/
virtual wxColour GetColour(int id);
@@ -112,8 +109,7 @@ public:
/**
Get the value of a certain setting.
@e id can be one of the size values of @b wxAuiPaneDockArtSetting.
@a id can be one of the size values of @b wxAuiPaneDockArtSetting.
*/
virtual int GetMetric(int id);
@@ -124,8 +120,7 @@ public:
/**
Set a certain setting with the value @e colour.
@e id can be one of the colour values of @b wxAuiPaneDockArtSetting.
@a id can be one of the colour values of @b wxAuiPaneDockArtSetting.
*/
virtual void SetColour(int id, const wxColor& colour);
@@ -136,8 +131,7 @@ public:
/**
Set a certain setting with the value @e new_val.
@e id can be one of the size values of @b wxAuiPaneDockArtSetting.
@a id can be one of the size values of @b wxAuiPaneDockArtSetting.
*/
virtual void SetMetric(int id, int new_val);
};