From 114a878c64ce6f8223cfd22d76a20eb16d177e5e Mon Sep 17 00:00:00 2001
From: toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>
Date: Wed, 25 Nov 2009 17:56:58 +0000
Subject: 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/kdevelop@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
---
 lib/interfaces/extensions/Mainpage.dox | 61 ++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 lib/interfaces/extensions/Mainpage.dox

(limited to 'lib/interfaces/extensions/Mainpage.dox')

diff --git a/lib/interfaces/extensions/Mainpage.dox b/lib/interfaces/extensions/Mainpage.dox
new file mode 100644
index 00000000..d306a1e8
--- /dev/null
+++ b/lib/interfaces/extensions/Mainpage.dox
@@ -0,0 +1,61 @@
+/**
+@mainpage The KDevelop Extension Interfaces Library
+
+This library contains extension interfaces used by KDevelop plugin architecture.
+
+<b>Link with</b>: -lkdevelop
+
+<b>Include path</b>: -I\$(kde_includes)/kdevelop/interfaces/extensions
+
+\section whatisextension What is the KDevelop extension
+
+Extension is a KDevelop plugin which implements one of extension interfaces.
+Extension is usually not important enough to be returned by @ref KDevApi and @ref KDevPlugin
+methods. Therefore extension instance can be obtained by @ref KDevPlugin::extension method.
+
+Note: extension plugins can be either core, global and project plugins. They are loaded
+in the same way other plugins are. But extensions differ from usual plugins.
+
+Note: many plugins implementing extension interface can be created but only one of
+those should be loaded at a time. This can be accomplished by:
+- using a shell plugin profile (as done in current generic shell implementation) - define
+  different X-KDevelop-Properties for different extension implementations;
+- writing project manager which looks into the project file and loads the neccesary extension.
+
+\section creatingextension Creating and using an extension
+- Define a service, use following .desktop file:
+  @code
+  [Desktop Entry]
+  Encoding=UTF-8
+  Type=ServiceType
+  X-KDE-ServiceType=KDevelop/MyExtension
+  X-KDE-Derived=KDevelop/Plugin
+  Name=My Extension Interface
+  [PropertyDef::X-KDevelop-Version]
+  Type=int
+  @endcode
+- Define an abstract base class for an extension like:
+  @code
+  class KDevMyExtension: public KDevPlugin {
+  public:
+      KDevMyExtension(const KDevPluginInfo *info, QObject* parent, const char* name)
+          :KDevPlugin(info, parent, name) {}
+      
+      virtual void doSomething() = 0;
+  };
+  @endcode  
+- Create an usual plugin, but instead of setting service type to "KDevelop/Plugin", set:
+  @code
+  ServiceTypes=KDevelop/MyExtension
+  @endcode
+- Use your extension:
+  @code
+  KDevMyExtension *myext = extension<KDevMyExtension>("KDevelop/MyExtension");
+  if (sf) {
+      // do something
+  } else {
+      // fail
+  }  
+  @endcode
+*/
+
-- 
cgit v1.2.3