From 592d94fadbb47569f45fd2cdaace788ffd878e6d Mon Sep 17 00:00:00 2001
From: Joel Holdsworth <joel@airwebreathe.org.uk>
Date: Wed, 15 Apr 2009 11:13:27 +0100
Subject: [PATCH] Updated switch_panel documentation

---
 src/gui/widgets/panel-bar.hpp       | 2 ++
 src/gui/workspace/panel-manager.hpp | 7 +++++++
 2 files changed, 9 insertions(+)

diff --git a/src/gui/widgets/panel-bar.hpp b/src/gui/widgets/panel-bar.hpp
index 36a327c11..000a28a33 100644
--- a/src/gui/widgets/panel-bar.hpp
+++ b/src/gui/widgets/panel-bar.hpp
@@ -75,6 +75,8 @@ private:
 
   /**
    * An event handler for when a panel type is chosen.
+   * @param type_index The index of the panel description that will be
+   * instantiated.
    **/
   void on_panel_type(int type_index);
 
diff --git a/src/gui/workspace/panel-manager.hpp b/src/gui/workspace/panel-manager.hpp
index 5abd454c6..1c462264e 100644
--- a/src/gui/workspace/panel-manager.hpp
+++ b/src/gui/workspace/panel-manager.hpp
@@ -81,6 +81,13 @@ public:
    **/
   WorkspaceWindow& get_workspace_window();
   
+  /**
+   * Switches a panel from one type to another, without touching the
+   * underlying GdlDockItem.
+   * @param old_panel The panel which will be transofrmed to a new type.
+   * @param new_panel_description_index The index of the panel
+   * description that will be instantiated.
+   **/
   void switch_panel(panels::Panel &old_panel,
     int new_panel_description_index);