Additional Contents of KDevelop Projects

Das KDevelop-Programmierhandbuch: Leitfaden zur C++-Anwendungsentwicklung für das K Desktop Environment (KDE) mit Hilfe der KDevelop-IDE in der Version 1.2
Zurück | Kapitel 3. Creating new Applications | Vor

# 3.4. Additional Contents of KDevelop Projects

Besides the source code provided, KDevelop projects contain a lot of other additional parts that are of interest to the developer. These are:

- a program icon

- a program mini-icon

- a .kdelnk file

- a sample SGML -documentation file

- a set of API -documentation generated from the framework source

Except the API -documentation, these elements of the project will be installed together with the application binary. As the project framework has to be as open as possible, you have to adapt these parts towards your project goals. These are first to edit the icons provided. This will give your application a unique identifier by which the user can determine your application visually in window manager menus. The .kdelnk file then is a file that installs your application into `kpanel` in the `Applications` menu. This has to be edited by setting the installation path which will be discussed later in this handbook. Finally, the documentation that you will provide to the user is written in SGML . This makes it very easy to create several different output from the same source. By default, KDevelop offers to create a set of HTML files from this source, for KDE-projects this will automatically use the `ksgml2html` program to add a consistent KDE look and feel to the documentation. In a later section, we will see how the SGML source is edited and what we have to watch for installation on the end-user.

Finally, the API (Application Programming Interface) documentation allows you and other developers to quickly get into the code and use the classes without having to guess what purpose each class is for. We will learn how to extend the API documentation in a later step, for now it lasts to know that the documentation is generated by the `KDoc` program, which processes the header files and creates the HTML output, therefore all documentation is placed in the headers.

Zurück | Anfang | Vor
The Source Skeleton | Hoch | Application View Design