summaryrefslogtreecommitdiffstats
path: root/cervisia/overview.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitbd9e6617827818fd043452c08c606f07b78014a0 (patch)
tree425bb4c3168f9c02f10150f235d2cb998dcc6108 /cervisia/overview.h
downloadtdesdk-bd9e6617827818fd043452c08c606f07b78014a0.tar.gz
tdesdk-bd9e6617827818fd043452c08c606f07b78014a0.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdesdk@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'cervisia/overview.h')
-rw-r--r--cervisia/overview.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/cervisia/overview.h b/cervisia/overview.h
new file mode 100644
index 00000000..e4af7af6
--- /dev/null
+++ b/cervisia/overview.h
@@ -0,0 +1,15 @@
+/**
+ * @libdoc Cervisia Class Overview
+ *
+ * This is the class documentation for the Cervisia CVS front end. At the moment,
+ * the only way this code can easily be used in other applications is via the
+ * KPart. Hopefully it should be possible to provide more flexible facilities in
+ * future versions.
+ *
+ * @li @ref CervisiaPart
+ * A KPart that provides a reusable way to embed the Cervisia interface in an app.
+ *
+ * @li @ref CervisiaShell
+ * A basic main window shell that embeds the CervisiaPart to provide the standalone
+ * Cervisia application.
+ */