Premiers pas avec QDoc

Qt utilise QDoc pour générer sa documentation aux formats HTML et DocBook XML. QDoc utilise un ensemble de fichiers de configuration pour générer la documentation à partir des commentaires QDoc. Les commentaires sont associés à des types appelés « topics » qui déterminent s’il s’agit d’une documentation de classe ou d’une documentation de propriété. Un commentaire peut également comporter des balises permettant d’ améliorer la mise en page et le formatage du résultat final.

Trois éléments sont indispensables pour générer de la documentation avec QDoc :

• QDoc fichiers de configuration binaires
• qdocconf fichiers de configuration
• Documentation dans les fichiers d'C++, QML et .qdoc

QDoc nécessite Clang pour analyser les fichiers d'en-tête et les fichiers source C++, ainsi que pour analyser les signatures de fonction dans les \fn commandes. Voir Installation de Clang pour QDoc pour plus de détails.

Cette section a pour objectif de présenter les éléments de base nécessaires à la création d’un ensemble de documentation. De plus, ce guide présente des considérations et des options spécifiques à la documentation d’API non-C++ ainsi qu’à la documentation QML. Enfin, ce guide fournit un exemple de documentation de projet et un exemple de documentation de type QML.

Pour des informations spécifiques sur QDoc, consultez le manuel de QDoc.

Chapitres

1. Installation de Clang pour QDoc
2. Création de fichiers de configuration QDoc
3. Rédaction de la documentation
4. Catégories de documentation
   • Style de documentation C++
   • Style de documentation QML
5. Dépannage des avertissements QDoc