Documentation de Classe avec KDoc

Le Manuel de Programmation de KDevelop: Le Manuel de l'Utilisateur pour la Conception d'Applications C++ pour l'Environnement de Bureau KDE avec l'EDI KDevelop, Version 1.2
Précédent |  | Suivant

# Chapitre 10. Documentation de Classe avec KDoc

Une autre partie importante de la documentation est la description informative des interfaces de votre classe. Cela vous permettra, ainsi qu'à d'autres programmeurs, d'utiliser vos classes en lisant la documentation HTML de la classe qui peut être générée avec `KDoc` . KDevelop supporte pleinement l'utilisation de `KDoc` pour créer la documentation des bibliothèques de KDE, ainsi vos architectures d'applications sont déjà documentées. Un bon point de départ, avant que vous ne rentriez vous-même dans le code fourni, est de lire la documentation en-ligne qui est incluse. Dans la suite, nous décrirons comment obtenir la documentation de l'API (NdT : Interface de Programmation d'Application, littéralement Application Programming Interface), où KDevelop vous permet de l'ajouter et quels sont les types de balises spéciales fournies en plus par `KDoc` .

# 10.1. Comment utiliser les Fonctionnalités de Documentation de KDevelop

Pour créer la documentation de l'API après avoir généré votre projet, sélectionnez "Construire la documentation de l'API " dans le menu "Projet". Cela traitera tous les fichiers d'en-tête et créera la sortie HTML. Ensuite, vous pourrez accéder à la documentation en choisisant "Documentation de l'API " dans le menu "Aide" ou bien le symbole de livre correspondant dans l'arborescence "Documentation", dossier "Projet courant".

La documentation contient déjà des références croisées entre les documentations en-ligne des classes de Qt et de KDE. Ainsi, vous pouvez suivre facilement l'héritage avec l'aperçu de l'héritage. Cela peut aussi vous aider à débuter avec les documentations de Qt et de KDE.

Précédent | Sommaire | Suivant
Comment appeler l'Aide dans les Boîtes de Dialogue |  | Ajouter la Documentation d'une Classe ou d'un Membre