summaryrefslogtreecommitdiffstats
path: root/cervisia/overview.h
diff options
context:
space:
mode:
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.
+ */