From 114a878c64ce6f8223cfd22d76a20eb16d177e5e Mon Sep 17 00:00:00 2001 From: toma 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 --- doc/platform/Mainpage.dox | 148 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 doc/platform/Mainpage.dox (limited to 'doc/platform') diff --git a/doc/platform/Mainpage.dox b/doc/platform/Mainpage.dox new file mode 100644 index 00000000..dd69ba92 --- /dev/null +++ b/doc/platform/Mainpage.dox @@ -0,0 +1,148 @@ +/** \file Mainpage.dox + \brief The main page of the doxygen generated %API Documentation +*/ + +/** +\mainpage The KDevelop Platform %API %Documentation + + +KDevelop Platform is set of libraries and tools that are used to build IDEs (Integrated Development Environments), +applications similar to IDEs (web development enviroment, text editors for programmers and designers, etc.) +and/or IDE plugins for all possible purposes. + +Platform provides: +- the plugin architecture (interfaces); +- the common support libraries; +- the generic shell with plugin profiles support. +. + +\section intro Introduction + +This document is targeted at all those that want to build their own IDE or improve KDevelop's source code. +If you are instead looking for a user manual, just go to the help menu of your KDevelop and select KDevelop handbook. +This documentation contains the KDevelop Platform online class reference for the current +development version of KDevelop. Additionally, you +can subscribe or read the mailing list for any additions and/or +modifications to the Platform %API. + +An on-line, updated every 24H, html version of this documentation can be found at: http://www.kdevelop.org/HEAD/doc/platform/html/index.html + +You can also download a local browseable copy form http://www.kdevelop.org/HEAD/doc/platform/kdevplatformdoc.tar.bz2 . It gets updated every single day too. + +More information about the KDevelop Platform architecture in form of tutorials, Wikis, HOWTOs, +and FAQs can be found at +the KDevelop website. + +Quick overviews of the architecture can also be found in the issues of +KDevelop Technotes. + +\section platformapi Platform Libraries API + +- Interfaces Library + (classes)\n + Interfaces and classes that form KDevelop plugin architecture. +- Extension Interfaces Library + (classes)\n + Extension interfaces used by KDevelop plugin architecture. +- Utility Library + (classes)\n + Utility classes for the KDevelop architecture. +- Extra Interfaces Library + (classes)\n + Extra interfaces that are not the part of KDevelop plugin architecture + but that can be implemented by extra plugins or "plugins for plugins". +- Widgets Library + (classes)\n + A collection of widgets. +- Property Editing Library + (classes)\n + A collection of facilities to store and edit the properties of various objects. +- Catalog Library + (classes)\n + The persistant symbol store library working with BerkeleyDb backend. +. + +\section designerapi GUI Designer Integration API + +- KInterfaceDesigner Library + (classes)\n + KInterfaceDesigner classes and interfaces which form the core of GUI Designer integration framework. +- Designer Integration Support Library + (classes)\n + The base classes to implement GUI designer integration in language support plugins. +. + +\section pluginsapi Platform Plugins API + +- Documentation Part Interfaces Library + (classes)\n + Interfaces to implement KDevelop documentation plugins. +. + +\section langapi Programming Language Support API + +- Language Support Interfaces Library + (classes)\n + Interfaces for KDevelop language support facilities. +- Debugger Support Library + (classes)\n + Classes to implement debugger support for a programming language. +. + +\section buildtoolapi Buildtool Support API + +- Buildtool Base Library + (classes)\n + Base classes for KDevelop builtool support plugins. +- Project Manager Interfaces Library + (classes)\n + Interfaces to implement plugins for the KDevelop generic project manager. +- Buildtool Widgets Library + (classes)\n + Widgets commonly used in buildtool support plugins. +- Autotools parser Library + (classes)\n + Parser for Autotools based support plugins. +- QMake parser Library + (classes)\n + Parser for QMake based support plugins. +. + +\section shellapi Shell API + +- Generic Shell + (classes)\n + The Shell - a profile-based implementation of KDevelop plugin architecture. +- Shell Profiles Library + (classes)\n + Plugin profiles implementation for KDevelop shell. +. + +\section PlannedTasks Planned tasks + +Here is a priority ordered list: + -# fix the dispersed fixme + -# reported bugs in bugzilla database + -# fix the dispersed todo all over the code. + . + +\section howTobuildAPIlocalcopy How to build a local copy of this documentation + +This documentation is large and changes with every cvs commit, therefore is not available for download. +To build your local copy of this documentation you need to fetch KDevelop sources and +if you have doxygen >= 1.3.4 and (optionally) PHP >= 4.10 plus a local running webserver then +- make apidox +- make install-apidox (as root) +. + +The advantage of the webserver is that you'll get a search engine in your documentation if you read your +documentation using your local webserver. + +\section License + +Permission is granted to copy, distribute and/or modify this document under +the terms of the GNU Free %Documentation License, Version 1.2 or any later +version published by the Free Software Foundation; For details see +http://www.gnu.org/copyleft/fdl.html . + +*/ -- cgit v1.2.1