From cedc2934c4bc8a5bc0be4112e492a4fb029fc7e6 Mon Sep 17 00:00:00 2001
From: "Aaron J. Seigo" <aseigo@kde.org>
Date: Sat, 28 Jul 2007 19:59:22 +0000
Subject: [PATCH] make it clear what services Applet provides in the apidox

svn path=/trunk/KDE/kdebase/workspace/libs/plasma/; revision=693718
---
 applet.h | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/applet.h b/applet.h
index 1e03e4195..2362aa9fb 100644
--- a/applet.h
+++ b/applet.h
@@ -36,9 +36,20 @@ class DataEngine;
 class Package;
 
 /**
- * @short The base Applet (Plasmoid) class
+ * @short The base Applet class
  *
+ * Applet provides several important roles for add-ons widgets in Plasma.
  *
+ * First, it is the base class for the plugin system and therefore is the
+ * interface to applets for host applications. It also handles the life time
+ * management of data engines (e.g. all data engines accessed via
+ * Applet::datEngine(const QString&) are properly deref'd on Applet
+ * destruction), background painting (allowing for consistent and complex
+ * look and feel in just one line of code for applets), loading and starting
+ * of scripting support for each applet, providing access to the associated
+ * plasmoid package (if any) and access to configuration data.
+ *
+ * See techbase.kde.org for tutorial on writing Applets using this class.
  */
 class PLASMA_EXPORT Applet : public QObject, public Widget
 {