La Documentation pour la documentation de Qt, des commentaires? Qt + Doxygen?

Où puis-je trouver de la documentation pour la documentation de Qt, des commentaires? Je fais allusion à la manière dont Qt utilise un style spécifique pour les commentaires de la documentation, comme suit:

/*!
    \class MyClassName
    \brief The MyClassName class is used as an example on Stack Overflow.

    This class serves a few functions, the most important being:

    \list
        \i So people can understand my question.
        \i So people can have a few laughs at the comedy in my example.
    \endlist
 */

...vous obtenez l'image. Alors, où puis-je trouver des informations sur tous les commutateurs, comme \classe, \liste, \brève, etc. Aussi, quel outil(s) dois-je utiliser pour générer des fichiers de documentation de ces commentaires dans mes fichiers sources? Ne Doxygen en charge cette syntaxe?

OriginalL'auteur Jake Petroules | 2010-06-17

  1. 8

    Ne pas utiliser qdoc. C'est déconseillé. Utiliser Doxygen, qui est basé sur qdoc de toute façon.

    Cela dit, la documentation (en qdoc format 😀 ) est ici.

    Je cherchais qt.gitorious.org/qt/pages/DocManual et qt.gitorious.org/qt/pages/DocMarkupCommands. Sans savoir ce qu'il a appelé (qdoc, hein?) Je ne pouvais pas Google. Beaucoup de liens semblent morts si
    Maintenant, vous dites que l'qdoc outil est obsolète, ou de l'ensemble de la qdoc syntaxe (y compris l'outil) est obsolète? Nokia utilise les qdoc syntaxe exclusivement dans Qt, est-ce juste pour la compatibilité ascendante ou un style différent (comme les commentaires Javadoc) être utilisé à la place? Bien évidemment, il est jusqu'à un programmeur, mais je veux rester cohérent avec le reste de l'intervalle Qt ou quoi que Nokia vous recommande de le.
    Merci pour l'info, qui m'avait épargné beaucoup de temps. J'allais pour qdoc3 ... imbécile!
    Êtes-vous sûr que la Documentation de Qt est (encore) obsolète? Le Lien que vous fournissez est mort, et il y a un qdoc de la documentation dans le courant de l'intervalle qt version.
    La réponse adresses Qt <= 4.8, depuis Qt 5 est sorti en 2012. Les liens pointent désormais à la intendend de contenu. Pour ce qui concerne Qt 5.x, qdoc3 a été renommé qdoc. Longue histoire courte, il être utilisé pour la documentation de mais, car il est conçu pour répondre documentation de Qt besoins, il peut changer incompatibilité d'une version à l'autre et il pourrait être nécessaire de faire un peu de travail pour le garder en cours d'exécution. Plus l'histoire peut être lue ici.

    OriginalL'auteur sml

  2. 1

    Il y a deux parties de doxygen qui sont qt spécifiques: le Qt Style de Commentaires et la QT_AUTOBRIEF Doxyfile configuration de la balise. Ce sont simplement des parties de doxygen qui sont utilisés par QT. Tous les commentaires doxygen utilisé par QT sont régulièrement doxygen choses. Donc, vous avez juste besoin de lire sur doxygen.

    Ou peut-être êtes-vous vraiment à la recherche de la documentation de QT internes, telles que des informations sur d-les Pointeurs contenus dans cette entrée de blog

    Qt Style Commentaires:
    Le /*! text */ commentaire style est appelé le "Qt Style" de doxygen commentaires. Le ! marques de l'ensemble du bloc de commentaire comme doxygen bloc de commentaire. C'est une série, en option, une partie de doxygen.

    QT_AUTOBRIEF réglage:
    si le "QT_AUTOBRIEF" tag est défini sur TRUE dans le Doxyfile, la première ligne d'un Qt style bloc de commentaire est automatiquement interprété comme le \brève description.

    De la doygen GUI aider:

    QT_AUTOBRIEF balise est définie sur OUI
    ensuite, doxygen d'interpréter la première
    ligne (jusqu'à ce que le premier point) d'un
    Qt-style de commentaire, comme la brève
    description. Si NON, l'
    les commentaires vont se comporter comme des
    Qt-les commentaires de style (ce qui nécessite l'
    explicite \brève commande pour une brève
    description.)

    OriginalL'auteur sschilz

  3. 1

    Utiliser doxygen pour créer de la documentation

    Il peut générer une documentation en ligne du navigateur (en HTML) et/ou un manuel de référence (LaTeX) à partir d'un ensemble de fichiers source. Il y a aussi un support pour la génération sortie en RTF (Word), PostScript, PDF avec hyperliens, HTML compressé, et les pages de manuel Unix. La documentation est extraite directement à partir des sources, ce qui le rend beaucoup plus facile de conserver la documentation cohérente avec le code source.

    Vous pouvez configurer doxygen pour extraire la structure du code de sans-papiers, les fichiers source. Ceci est très utile pour trouver rapidement votre chemin dans les grandes distributions source. Vous pouvez également visualiser les relations entre les différents éléments à l'aide d'inclure des graphiques de dépendance, de succession, de schémas et de diagrammes de collaboration, qui sont tous générés automatiquement.

    http://www.doxygen.nl/

    OriginalL'auteur Pardeep

  4. 0

    Vous pouvez prendre un coup d'oeil au code source de Qt lui-même pour la documentation de Qt commentaires...

    Qt - SRC - 4.6.3

    J'ai utilisé DOxygen pour la documentation et pour moi ça fonctionne, bien que les normes en matière de documentation ne sont pas de l'intervalle Qt. Je vous suggère de faire un essai si et décider.

    OriginalL'auteur liaK