sd: document the left pane classes

Change-Id: Id037e2f5f733ef7266ef6d48ff2ff7dea956ea25
Reviewed-on: https://gerrit.libreoffice.org/69070
Reviewed-by: Andras Timar <andras.timar@collabora.com>
Tested-by: Andras Timar <andras.timar@collabora.com>
Reviewed-on: https://gerrit.libreoffice.org/73487
Tested-by: Jenkins
Reviewed-by: Jan Holesovsky <kendy@collabora.com>

1 files changed, 7 insertions, 2 deletions

diff --git a/sd/source/ui/inc/PaneChildWindows.hxx b/sd/source/ui/inc/PaneChildWindows.hxx
index d277a808d6b7..ff72731b822c 100644
--- a/sd/source/ui/inc/PaneChildWindows.hxx
+++ b/sd/source/ui/inc/PaneChildWindows.hxx
@@ -24,6 +24,7 @@
 
 namespace sd {
 
+/// Base class of Impress and Draw left sidebars/panes.
 class PaneChildWindow
     : public SfxChildWindow
 {
@@ -37,20 +38,24 @@ public:
     virtual ~PaneChildWindow() override;
 };
 
+/// The slide-sorter sidebar (on the left) in Impress.
 class LeftPaneImpressChildWindow
     : public PaneChildWindow
 {
 public:
-    LeftPaneImpressChildWindow (vcl::Window*, sal_uInt16, SfxBindings*, SfxChildWinInfo*);
+    LeftPaneImpressChildWindow(vcl::Window* pParentWindow, sal_uInt16 nId, SfxBindings* pBindings,
+                               SfxChildWinInfo* pInfo);
 
     SFX_DECL_CHILDWINDOW_WITHID(LeftPaneImpressChildWindow);
 };
 
+/// The pages sidebar (on the left) in Draw.
 class LeftPaneDrawChildWindow
     : public PaneChildWindow
 {
 public:
-    LeftPaneDrawChildWindow (vcl::Window*, sal_uInt16, SfxBindings*, SfxChildWinInfo*);
+    LeftPaneDrawChildWindow(vcl::Window* pParentWindow, sal_uInt16 nId, SfxBindings* pBindings,
+                            SfxChildWinInfo* pInfo);
 
     SFX_DECL_CHILDWINDOW_WITHID(LeftPaneDrawChildWindow);
 };