Add clang-format and format code as in Frameworks

[dolphin.git] / src / selectionmode / backgroundcolorhelper.h

diff --git a/src/selectionmode/backgroundcolorhelper.h b/src/selectionmode/backgroundcolorhelper.h
index 0e8a61b34825932879f66501cc86d0ea7bf62773..251c5eddf53e2eca396477263ace318de21893a3 100644 (file)
--- a/src/selectionmode/backgroundcolorhelper.h
+++ b/src/selectionmode/backgroundcolorhelper.h
@@ -1,6 +1,6 @@
 /*
     This file is part of the KDE project
-    SPDX-FileCopyrightText: 2022 Felix Ernst <fe.a.ernst@gmail.com>
+    SPDX-FileCopyrightText: 2022 Felix Ernst <felixernst@zohomail.eu>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
@@ -15,6 +15,9 @@
 
 class QWidget;
 
+namespace SelectionMode
+{
+
 /**
  * @brief A Singleton class for managing the colors of selection mode widgets.
  */
@@ -25,21 +28,33 @@ public:
 
     /**
      * Changes the background color of @p widget to a distinct color scheme matching color which makes it clear that the widget belongs to the selection mode.
+     * The background color of @p widget will from now on be updated automatically when the palette of the application changes.
      */
     void controlBackgroundColor(QWidget *widget);
 
 private:
     BackgroundColorHelper();
 
+    /**
+     * Called when the palette of the application changes.
+     * Triggers updateBackgroundColor() and the updates the background color of m_colorControlledWidgets.
+     * @see updateBackgroundColor
+     */
     void slotPaletteChanged();
 
+    /** Calculates a new m_colorControlledWidgets based on the current colour scheme of the application. */
     void updateBackgroundColor();
 
 private:
+    /// The widgets who have given up control over the background color to BackgroundColorHelper.
     std::vector<QPointer<QWidget>> m_colorControlledWidgets;
+    /// The color to be used for the widgets' backgrounds.
     QColor m_backgroundColor;
 
+    /// Singleton object
     static BackgroundColorHelper *s_instance;
 };
 
+}
+
 #endif // BACKGROUNDCOLORHELPER_H