The KDevelop Source Code Documentation
Version SVN trunk HEAD
KDevelop is an easy to use IDE (Integrated Development Environment) for developing applications under Unix, MacOS, Windows, Solaris and BSD.KDevelop itself is written in C++. To simplify its code it uses several libraries as can be seen in the diagram bellow. KDevelop Platform is a 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.
KDevelop Platform provides:
- the plugin architecture (interfaces);
- the common support libraries;
- the generic shell with plugin profiles support.
| KDevelop source code documentation (this document) |
| KDevelop Platform Libraries >= 4.0 API Reference |
| KDE Library >= 4.1 API Reference |
| Qt C++ Framework >= 4.4 Reference documentation |
| Operative system Any of: |
Introduction
This document is targeted at all those that want to add 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 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 API.An on-line, updated every 24H, html version of this documentation can be found at: http://www.kdevelop.org/HEAD/doc/api/html/index.html
More information about the KDevelop architecture in form of tutorials, HOWTOs, and FAQs can be found at the KDevelop website.
Current Status
KDevelop RequirementsKDevelop Features
Programming Languages Support Status (doc/api/LangSupportStatus.dox file)
How to extend KDevelop
First of all read the architecture (doc/api/Architecture.dox file) then you can find more information on how to extend KDevelop:- How to extend KDevelop via plugins (doc/api/HowToAddPlugins.dox file)
- How to add support for a programming language (doc/api/HowToAddProgrammingLanguages.dox file)
- How to add application templates to the application wizard part (doc/api/HowToAddApplicationTemplates.dox file)
- How to add file templates to the file create part (doc/api/HowToAddFileTemplates.dox file)
- How to add a generic build tool plugins to the generic build tool part (doc/api/HowToAddGenericBuildTools.dox file)
Additionally you may also want to find out How to document KDevelop parts (doc/api/HowToDocument.dox file).
How to participate in KDevelop development
KDevelop Development Team Cooperation Model
KDevelop is the result of the work of many people. To help syncronize the effords and to automate some tasks, the team uses many tools:
- SVN repository
- KDE Bugzilla
- Web servers
- Mailing Lists
- IRC
- Doxygen
- docbook
- LXR
- Cron Jobs
- and of course KDevelop :)
Joining the Team
You're always welcome to join the team. Read the detailed guide on how to proceed.Planned tasks
Here is a priority ordered list:- fix the dispersed Fixme
- fix reported bugs in bugzilla database
- fix the dispersed Todo List all over the code.
Misc
How to build a local copy of this documentation
This documentation is very large and changes with every svn commit, therefore is not available for download. To build your local copy of this documentation download doxygen version 1.5.0 or newer and:- export KDEDIR=/location_of_your_kde_instalation
- export QTDIR=/location_of_your_qt_instalation
- doxygen
- make install-apidox (as root)
