[Libreoffice-commits] core.git: include/sfx2

[Miklos Vajna (via logerrit)]

 include/sfx2/sidebar/Deck.hxx  |    3 +++
 include/sfx2/sidebar/Panel.hxx |    4 ++++
 2 files changed, 7 insertions(+)

New commits:
commit 50dec9d1d7fe292a8165f19a3553662effe9e64f
Author:     Miklos Vajna <vmiklos at collabora.com>
AuthorDate: Fri Feb 28 15:27:21 2020 +0100
Commit:     Miklos Vajna <vmiklos at collabora.com>
CommitDate: Fri Feb 28 20:57:27 2020 +0100

    sfx2 sidebar: document deck vs panel relationship
    
    Change-Id: Ib3e4c138a29bca4311520bf16ce00bfbdb22e72d
    Reviewed-on: https://gerrit.libreoffice.org/c/core/+/89719
    Reviewed-by: Miklos Vajna <vmiklos at collabora.com>
    Tested-by: Jenkins

diff --git a/include/sfx2/sidebar/Deck.hxx b/include/sfx2/sidebar/Deck.hxx
index 98738d814a7e..79815a9bb283 100644
--- a/include/sfx2/sidebar/Deck.hxx
+++ b/include/sfx2/sidebar/Deck.hxx
@@ -32,6 +32,9 @@ class DeckTitleBar;
 
 /** This is the parent window of the panels.
     It displays the deck title.
+
+    A deck consists of multiple panels.
+    E.g. Properties, Styles, Navigator.
 */
 class Deck final : public vcl::Window
 {
diff --git a/include/sfx2/sidebar/Panel.hxx b/include/sfx2/sidebar/Panel.hxx
index 2c0e9bd764c2..3fe5a4dbcfed 100644
--- a/include/sfx2/sidebar/Panel.hxx
+++ b/include/sfx2/sidebar/Panel.hxx
@@ -36,6 +36,10 @@ class PanelDescriptor;
 class PanelTitleBar;
 class Context;
 
+/**
+ * Multiple panels form a single deck.
+ * E.g. the Properties deck has panels like Styles, Character, paragraph.
+ */
 class SFX2_DLLPUBLIC Panel final : public vcl::Window
 {
 public: