/** \file doc/api/Mainpage.dox
    \brief The main page of the doxygen generated API Documentation
*/

/**
\mainpage 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.
\n \n
%KDevelop itself is written in C++. To simplify its code it uses several libraries as can be seen in the diagram bellow.
<i>%KDevelop Platform</i> 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.

<i>%KDevelop Platform</i> provides:
- the plugin architecture (interfaces);
- the common support libraries;
- the generic shell with plugin profiles support.
.

<i>%KDevelop Platform</i>, %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.

<table width="400" border="0" align="center">
  <tr>
    <td bgcolor="#EFF7E3" align="center"><b>%KDevelop</b><br><a href="http://www.kdevelop.org/HEAD/doc/api/html/">source code documentation</a> (this document)</td>
  </tr>
  <tr>
    <td bgcolor="#BCD49A" align="center"><b>%KDevelop Platform Libraries</b> &gt;= 4.0<br><a href="http://api.kde.org/4.x-api/kdevplatform-apidocs/">API Reference</a></td>
  </tr>
  <tr>
    <td bgcolor="#548CDD" align="center"><b>%KDE Library</b> &gt;= 4.1<br><a href="http://api.kde.org/4.x-api/kdelibs-apidocs/">API Reference</a></td>
  </tr>
  <tr>
    <td bgcolor="#A2C511" align="center"><b>Qt C++ Framework</b> &gt;= 4.4<br><a href="http://doc.trolltech.com/4.4beta/index.html">Reference documentation</a></td>
  </tr>
  <tr>
    <td bgcolor="#FFA1FA" align="center"><b>Operative system</b><br>
    Any of:<ul>
    <li><a href="http://www.linux.org/">Linux</a></li>
    <li><a href="http://www.apple.com/macosx/">Mac OS X</a></li>
    <li><a href="http://www.windows.com/">Microsoft Windows</a></li>
    <li><a href="http://www.sun.com/software/solaris/">Sun Solaris</a></li>
    <li><a href="http://www.freebsd.org/">Free BSD/open BSD</a></li>
    </ul>
  </tr>
</table>


\section Introduction 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 <a href="http://www.kdevelop.org/index.html?filename=mailinglist.html">mailing list</a> 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 <a href="http://www.kdevelop.org/">KDevelop website</a>.


\section status Current Status

<a href="http://www.kdevelop.org/index.html?filename=HEAD/requirements.html">KDevelop Requirements</a> \n
<a href="http://www.kdevelop.org/index.html?filename=HEAD/features.html">KDevelop Features</a> \n


\section expand How to extend KDevelop

Read the <a href="http://api.kde.org/4.x-api/kdevplatform-apidocs/">KDevPlatform apidocs</a> and look into the <a href="http://www.kdevelop.org/mediawiki/index.php/KDevelop_4">KDevelop4 Wiki</a>.

Additionally you may also want to find out \ref howToDocument (doc/api/HowToDocument.dox file).

\section participate How to participate in KDevelop development

\subsection cooperation 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:

\image html Development.png

\subsection join Joining the Team

You're always welcome to join the team. Read the
<a href="http://www.kdevelop.org/index.html?filename=join-the-team.html">detailed guide</a> on how to proceed.

\section PlannedTasks Planned tasks

Here is a priority ordered list:
  -# fix the dispersed \ref fixme
  -# <a href="http://bugs.kde.org/buglist.cgi?product=kdevelop&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.bug_id">fix reported bugs in bugzilla database</a>
  -# fix the dispersed \ref todo all over the code.
  .

For the list of future tasks, ideas, unmaintained plugins and many more, visit
<a href="http://www.kdevelop.org/mediawiki/index.php/Main_Page">KDevelop Wiki</a>

\section misc Misc

  - <a href="http://www.kdevelop.org/index.html?filename=HEAD/authors.html">Authors</a>
  - <a href="http://www.kdevelop.org/mediawiki/index.php/FAQ">FAQ</a>

\section howTobuildAPIlocalcopy 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)
.

\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 .

*/
