From: Benjamin Williams <bwilliams@kirix.com>
Date: Fri, 30 Jun 2006 07:28:39 +0000 (+0000)
Subject: added/expanded various comments
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/cc0196c7944434aa873835b9a70ee0e23f3a38d3

added/expanded various comments


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39897 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/src/aui/framemanager.cpp b/src/aui/framemanager.cpp
index 8ceba22d20..99614d7638 100644
--- a/src/aui/framemanager.cpp
+++ b/src/aui/framemanager.cpp
@@ -333,7 +333,9 @@ static void RenumberDockRows(wxDockInfoPtrArray& docks)
 }
 
 
-
+// SetActivePane() sets the active pane, as well as cycles through
+// every other pane and makes sure that all others' active flags
+// are turned off
 static void SetActivePane(wxPaneInfoArray& panes, wxWindow* active_pane)
 {
     int i, pane_count;
@@ -544,7 +546,9 @@ void wxFrameManager::ProcessMgrEvent(wxFrameManagerEvent& event)
 
 // SetArtProvider() instructs wxFrameManager to use the
 // specified art provider for all drawing calls.  This allows
-// plugable look-and-feel features
+// plugable look-and-feel features.  The pointer that is
+// passed to this method subsequently belongs to wxFrameManager,
+// and is deleted in the frame manager destructor
 void wxFrameManager::SetArtProvider(wxDockArt* art_provider)
 {
     // delete the last art provider, if any
@@ -554,6 +558,7 @@ void wxFrameManager::SetArtProvider(wxDockArt* art_provider)
     m_art = art_provider;
 }
 
+
 bool wxFrameManager::AddPane(wxWindow* window, const wxPaneInfo& pane_info)
 {
     // check if the pane has a valid window
@@ -698,6 +703,8 @@ bool wxFrameManager::InsertPane(wxWindow* window, const wxPaneInfo& pane_info,
 }
 
 
+// DetachPane() removes a pane from the frame manager.  This
+// method will not destroy the window that is removed.
 bool wxFrameManager::DetachPane(wxWindow* window)
 {
     int i, count;