The KDevelop API Documentation
Version 3.0.4
KDevelop is an easy to use IDE (Integrated Development Environment) for developing applications under X11.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://developer.kde.org/documentation/library/cvs-api/kdevelop/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
Here you can see the current Requirements and the Features. There is also a Programming Languages Support Status (doc/api/LangSupportStatus.dox file) page and a Editors Support Status (doc/api/EditorsSupportStatus.dox file) page.How to expand KDevelop
First of all read the KDevelop 3 Architecture (doc/api/Architecture.dox file) then you can find more information on how to expand 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).
Planned tasks
Here is a priority ordered list:- High priority tasks! (doc/api/HighPriTasks.dox file)
- fix the dispersed Fixme
- reported bugs in bugzilla database
- fix the bugs in the Bug List
- fix the dispersed Todo List all over the code.
There is also Future tasks and ideas for the next release of KDevelop (doc/api/FutureTasks.dox file). Put all ideas for the future KDevelop releases there. It is also a good place to comment on those ideas.
Misc
How to build a local copy of this documentation
This documentation is very large and changes with every cvs commit, therefore is not available for download. To build your local copy of this documentation you have two choices, depending on your system configuration.- If you have KDE >= 3.2 , doxygen >= 1.3.4 , PHP >= 4.10 and a local running webserver then
- make apidox
- make install-apidox (as root)
- If you have an older system then
- setenv KDEDIR=/location_of_your_kde_instalation
- setenv QTDIR=/location_of_your_qt_instalation
- doxygen Doxyfile
- make install-apidox (as root)