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

Improve links in wxAuiManager flags documentation.

Browse Source 
Use @param tags and "::" to link enum name.

Closes #13689.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70248 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-01-03 00:40:32 +00:00
parent bb65ca31d7
commit 94cac3bf82
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
interface/wx/aui/framemanager.h
View File

@@ -172,9 +172,13 @@ class wxAuiManager : public wxEvtHandler
{ {
public: public:
/** /**
Constructor. @a managed_wnd specifies the wxFrame which should be managed. Constructor.
@a flags specifies the frame management behaviour and visual effects
with the wxAuiManagerOption's style flags. @param managed_wnd
Specifies the wxFrame which should be managed.
@param flags
Specifies the frame management behaviour and visual effects
with the ::wxAuiManagerOption's style flags.
*/ */
wxAuiManager(wxWindow* managed_wnd = NULL, wxAuiManager(wxWindow* managed_wnd = NULL,
unsigned int flags = wxAUI_MGR_DEFAULT); unsigned int flags = wxAUI_MGR_DEFAULT);
@@ -226,7 +230,7 @@ public:
void GetDockSizeConstraint(double* widthpct, double* heightpct) const; void GetDockSizeConstraint(double* widthpct, double* heightpct) const;
/** /**
Returns the current wxAuiManagerOption's flags. Returns the current ::wxAuiManagerOption's flags.
*/ */
unsigned int GetFlags() const; unsigned int GetFlags() const;
@@ -336,7 +340,7 @@ public:
void SetDockSizeConstraint(double widthpct, double heightpct); void SetDockSizeConstraint(double widthpct, double heightpct);
/** /**
This method is used to specify wxAuiManagerOption's flags. @a flags This method is used to specify ::wxAuiManagerOption's flags. @a flags
specifies options which allow the frame management behaviour to be modified. specifies options which allow the frame management behaviour to be modified.
*/ */
void SetFlags(unsigned int flags); void SetFlags(unsigned int flags);