Class Documentation with KDoc

O Manual de Programação do KDevelop: O Guia do Utilizador para Desenvolvimento de Aplicações C++ para o Ambiente de Trabalho K (KDE) com o ambiente de trabalho KDevelop, Versão 2.1
Prev |  | Next

# Capítulo 10. Class Documentation with KDoc

Another important part of the documentation is including a descriptive help for your class interfaces. This will allow you and other programmers to use your classes by reading the HTML class documentation that can be created with `KDoc` . KDevelop supports the use of `KDoc` completely by creating the KDE-library documentation, also your application frameworks are already documented. To work yourself into the provided code, it would be a good start to read the included documentation online. The following describes what to do to get the API documentation, where KDevelop helps you add it and what kind of special tags `KDoc` provides additionally.

# 10.1. How to use KDevelop's Documentation features

To create the API documentation after you generated a project, select "Make API -Doc" from the "Project" menu. This will process all header files and create the HTML output. Then you can access the documentation by selecting "API -Documentation" from the Help-menu or the according book symbol in the Documentation tree, folder "Current Project".

The documentation is already cross-referenced to the KDE and Qt online-class documentation , so you can follow the inheritance easily with the inheritance overview. This may help you getting started with the KDE and Qt documentation as well.

Prev | Home | Next
How to call Help in Dialogs |  | Adding Class and Member Documentation