Add documentation on Applet/Containment Interface

Change-Id: I3dddb4d799fef98eb4370503ac8f1d20c6948b2d

src/plasmaquick/Mainpage.dox

@@ -0,0 +1,21 @@
+/** @page libplasmaquick libplasmaquick
+
+libplasmaquick is an internal part of lib plasma.
+
+It should not be used directly, however some classes are exposed to Plasma as attached properties.
+
+Namely:
+ - AppletInterface
+ - ContainmentInterface
+
+which are exposed as "Plasmoid" for applets and containments respectively.
+
+QML applets should import org.kde.plasma.plasmoid 2.0 in order to access this attached object
+
+*/
+
+// DOXYGEN_SET_PROJECT_NAME = Plasma
+// DOXYGEN_SET_RECURSIVE = YES
+// DOXYGEN_EXCLUDE_PATTERNS = *_p.h */private/* */tests/*
+
+// vim:ts=4:sw=4:expandtab:filetype=doxygen

src/scriptengines/qml/plasmoid/appletinterface.h

@@ -48,6 +48,13 @@ namespace Plasma
 class ConfigLoader;
 } // namespace Plasma
 
+/**
+ * @class AppletInterface
+ *
+ * @short This class is exposed to applets in QML as the attached property Plasmoid
+ *
+ * \@import org.kde.plasma.Plasmoid
+ */
 class AppletInterface : public PlasmaQuick::AppletQuickItem
 {
     Q_OBJECT

src/scriptengines/qml/plasmoid/containmentinterface.h

@@ -40,6 +40,14 @@ namespace KActivities
 class Info;
 }
 
+
+/**
+ * @class ContainmentInterface
+ *
+ * @brief This class is exposed to containments QML as the attached property Plasmoid
+ *
+ *
+ */
 class ContainmentInterface : public AppletInterface
 {
     Q_OBJECT