[krusader] krusader/GUI: GUI: Added documention for ProfileManager explaining the class

[Alexander Bikadorov]

Git commit ac2e96abfa26ee9a35782c6ef147bf10813fa239 by Alexander Bikadorov.
Committed on 25/04/2017 at 19:04.
Pushed by abikadorov into branch 'master'.

GUI: Added documention for ProfileManager explaining the class

M  +16   -0    krusader/GUI/profilemanager.h

https://commits.kde.org/krusader/ac2e96abfa26ee9a35782c6ef147bf10813fa239

diff --git a/krusader/GUI/profilemanager.h b/krusader/GUI/profilemanager.h
index af2147d6..a9b94579 100644
--- a/krusader/GUI/profilemanager.h
+++ b/krusader/GUI/profilemanager.h
@@ -36,6 +36,22 @@
 // QtWidgets
 #include <QPushButton>
 
+/**
+ * A generic profile manager: Profiles are arbitray configurations groups and the manager handles
+ * saving/loading multiple groups to/from the configuration.
+ *
+ * A manager instance is responsible for a profile type specified by a type name:
+ * "Panel", "SelectionProfile", "SearcherProfile", "SynchronizerProfile", ...
+ *
+ * Profiles are numbered in the configuration group name and have an additional name property. E.g.
+ *
+ * [Panel - 2]
+ * Name=Media Profile
+ * ...
+ *
+ * This class is view and model at the same time :/
+ * The GUI button opens a popup menu for selecting, creating, overwriting and removing profiles.
+ */
 class ProfileManager : public QPushButton
 {
     Q_OBJECT