diff options
Diffstat (limited to 'lib/interfaces/extensions/Mainpage.dox')
-rw-r--r-- | lib/interfaces/extensions/Mainpage.dox | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/lib/interfaces/extensions/Mainpage.dox b/lib/interfaces/extensions/Mainpage.dox index 63b467ce..c9b3af92 100644 --- a/lib/interfaces/extensions/Mainpage.dox +++ b/lib/interfaces/extensions/Mainpage.dox @@ -1,15 +1,15 @@ /** -@mainpage The TDevelop Extension Interfaces Library +@mainpage The KDevelop Extension Interfaces Library -This library contains extension interfaces used by TDevelop plugin architecture. +This library contains extension interfaces used by KDevelop plugin architecture. <b>Link with</b>: -ltdevelop <b>Include path</b>: -I\$(kde_includes)/tdevelop/interfaces/extensions -\section whatisextension What is the TDevelop extension +\section whatisextension What is the KDevelop extension -Extension is a TDevelop plugin which implements one of extension interfaces. +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. @@ -19,7 +19,7 @@ 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-TDevelop-Properties for different extension implementations; + 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 @@ -28,10 +28,10 @@ those should be loaded at a time. This can be accomplished by: [Desktop Entry] Encoding=UTF-8 Type=ServiceType - X-KDE-ServiceType=TDevelop/MyExtension - X-KDE-Derived=TDevelop/Plugin + X-KDE-ServiceType=KDevelop/MyExtension + X-KDE-Derived=KDevelop/Plugin Name=My Extension Interface - [PropertyDef::X-TDevelop-Version] + [PropertyDef::X-KDevelop-Version] Type=int @endcode - Define an abstract base class for an extension like: @@ -44,13 +44,13 @@ those should be loaded at a time. This can be accomplished by: virtual void doSomething() = 0; }; @endcode -- Create an usual plugin, but instead of setting service type to "TDevelop/Plugin", set: +- Create an usual plugin, but instead of setting service type to "KDevelop/Plugin", set: @code - ServiceTypes=TDevelop/MyExtension + ServiceTypes=KDevelop/MyExtension @endcode - Use your extension: @code - KDevMyExtension *myext = extension<KDevMyExtension>("TDevelop/MyExtension"); + KDevMyExtension *myext = extension<KDevMyExtension>("KDevelop/MyExtension"); if (sf) { // do something } else { |