[devhelp] Profile: document the requirements

[Sébastien Wilmet <swilmet src gnome org>]

commit 7ad7bf013d5c3db0dce914ca12cd7e80c86853c8
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Wed Apr 4 19:17:02 2018 +0200

    Profile: document the requirements

 devhelp/dh-profile.c |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)
---
diff --git a/devhelp/dh-profile.c b/devhelp/dh-profile.c
index d5d6e26..bee2967 100644
--- a/devhelp/dh-profile.c
+++ b/devhelp/dh-profile.c
@@ -27,6 +27,24 @@
  * @Short_description: libdevhelp profile
  */
 
+/* Requirements:
+ *
+ * Support multiple in-process profiles (containing GSettings among other
+ * things). For example one generic profile and one profile for GNOME, to keep
+ * the Devhelp application generic and suitable for different development
+ * platforms (all that is needed is that the documentation is available in HTML
+ * with *.devhelp2 index files).
+ *
+ * Possibility to run in parallel multiple profiles in the same process, for
+ * example:
+ * - In an IDE for different projects or different programming languages, i.e.
+ *   different book selections.
+ * - In the Devhelp app with several windows.
+ *
+ * Be able to share some GSettings keys (or at least some sub-schemas) between
+ * different profiles. It's possible with DhSettings.
+ */
+
 struct _DhProfilePrivate {
         DhSettings *settings;
 };