doc/api

The KDevelop Source Code Documentation

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 Platform, KDE and KDevelop itself all use the Qt C++ framework. This framework can be used on top of many operative systems. This makes KDevelop a trully multiplatform application.

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 Requirements
KDevelop Features

How to extend KDevelop

Read the KDevPlatform apidocs and look into the KDevelop4 Wiki.

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
E-mail
Cron Jobs
and of course KDevelop :)

They get interconnected like this:

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 all over the code.

For the list of future tasks, ideas, unmaintained plugins and many more, visit KDevelop Wiki

Misc

Authors
FAQ

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)

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 .