Démarrer 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 de la documentation à partir des commentaires QDoc. Les commentaires ont des types appelés sujets qui déterminent si un commentaire est une documentation de classe ou une documentation de propriété. Un commentaire peut également être balisé afin d'améliorer la mise en page et le formatage du résultat final.

Il existe trois matériaux essentiels pour générer de la documentation avec QDoc :

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

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

Cette section a pour but de couvrir les besoins de base pour la création d'un jeu de documentation. En outre, le guide présente des considérations spéciales et des options pour documenter la documentation des API non-C++ ainsi que la documentation QML. Enfin, le 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 QDoc.

Chapitres

1. Installation de Clang pour QDoc
2. Création des fichiers de configuration de 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 de QDoc