Utilisation de la documentation automatique de ma propre fonction avec Qt Creator?

J'ai été en utilisant Qt Creator et j'ai décidé que je voulais documenter une fonction que j'avais écrit j'ai donc placé mon curseur au-dessus de ma définition de la fonction et tapé /**<ENTER> comme suit:

/**<ENTER>
void MyClass::myFunction(int myArg)
{
...

Qt Creator auto-élargi ce commentaire:

/**
 * @brief MyClass::myFunction
 * @param myArg
 */
void MyClass::myFunction(int myArg)
{
...

Qu'est-ce que cela? Où est-il documenté?

Puis-je générer mon propre Qt Assistant qch fichiers d'aide ou quelque chose?

source d'informationauteur Cory Klein

  1. 27

    Doivent être documentés ici ou icimais ce n'est pas...

    Voici donc quelques infos à ce sujet:

    Les paramètres de cette fonction sont disponibles ici:

    Windows:

    Qt Creator > Outils > Options > Editeur de Texte > l'Achèvement > Commentaires de Documentation

    Mac OS X:

    Qt Creator > Préférences > Editeur de Texte > l'Achèvement > Commentaires de Documentation

    Les trois options listes sont:

    • Permettre Doxygen blocs
    • Générer brève description
    • Ajouter des astérisques

    (Qui se trouve dans Qt 2.6, mais peut-être dans les versions antérieures, trop?, ou il peut faire partie de l'plugin par défaut fixé à un certain point.)

    Les talons qui sont créés sont Doxygen style talons.

    Vous pouvez utiliser doxygen à exécuter par le biais de votre code source et de créer un peu de fantaisie à la documentation, à la fois dans un fichier chm et dans un document html et pdf.

    http://www.stack.nl/~dimitri/doxygen/

    http://www.stack.nl/~dimitri/doxygen/manual/output.html (comprend qch fichiers)

    Ici est un plugin pour Qt Creator:

    http://dev.kofee.org/projects/qtcreator-doxygen/wiki

    Et à l'aide de la QHelpEngine dans votre propre programme...

    http://qt-project.org/doc/qt-4.8/qthelp-framework.html

    Et enfin, vous pouvez utiliser QDesktopServices pour gérer une aide de style url:

    http://doc-snapshot.qt-project.org/4.8/qdesktopservices.html#url-handlers

    Espère que ça aide.