Comment intégrer des exemples avec Doxygen?

J'ai documenté toutes mes classes et je souhaite maintenant intégrer un exemple d'utilisation de ces classes. Comment dois-je faire?

InformationsquelleAutor Tobi Weißhaar | 2012-01-24
  1. 34

    Vous pouvez mettre de l'exemple de code source dans un chemin défini dans le doxygen la config dans EXAMPLE_PATH, puis insérer des exemples avec le @example tag.

    Doxygen va alors générer une page supplémentaire contenant la source de l'exemple. Il permettra aussi d'établir un lien à partir de la classe de documentation contenant l'exemple de tag.

    Sinon, si vous voulez utiliser de petits fragments de code que vous pouvez insérer avec @code ... @endcode

    La documentation est ici:
    la documentation doxygen?

    • Oui je l'ai fait mais la .rpc-les fichiers dans la page supplémentaire est vide :/
    • hmmm ne doxygen donner un avertissement ou une erreur?
    • Pas de. J'ai inclus les fichiers de l'exemple dans la balise d'ENTRÉE et dans la balise EXAMPLE_PATH les fichiers qui ont le tag \exemple...ne sais pas quel est la faute
    • Dois-je utiliser un tag spécial à l'exemple du rpc-files?
    • vous devrez peut-être l'échanger. Je vais donner un exemple: Vous avez tout le code source dans myproject/src, des exemples (qui sont juste a commenté le code source) dans myproject/examples et extra fichiers de documentation (qui peuvent utiliser des exemples) dans myproject/doc. Dans la config, ENTRÉE aurez besoin myproject/src et myproject/doc. EXAMPLE_PATH doit être réglé à myproject/examples.
    • Je l'ai eu...j'ai oublié d'ajouter l'exemple du rpc-les fichiers de la EXAMPLE_PATH^^
    • J'ai du mal à suivre leur documentation. Trop de mots pour une petite question/réponse. J'ai juste ouvert et DONC, nous y voilà! Merci.

    InformationsquelleAutor Loebl
  2. 18

    Une autre façon de le faire est d'utiliser le \snippet commande.

    • Dans votre fichier d'en-tête d'écrire quelque chose comme:
    \section ex1 Example
\snippet path_to_test_class/TestClass.cpp TestClass example
\section ex2 Expected output
\snippet path_to_test_class/TestClass.cpp TestClass expected output
    • Dans le TestClass.cpp fichier, avoir quelque chose comme:
     //! [OptimizeSpeedOnTrackTest example]
 Class c;
 const double res = c.do_something();
 //! [OptimizeSpeedOnTrackTest example]
 //! [OptimizeSpeedOnTrackTest expected output]
 ASSERT_DOUBLE_EQ(5,res);
 //! [OptimizeSpeedOnTrackTest expected output]

    path_to_test_class doit être dans votre EXAMPLE_PATH.

    Cela vous donne la suivante:

    • Vos exemples ne sont pas juste là pour la documentation: ils fournissent une couverture de test ainsi
    • Votre test runner (& votre compilateur) vous donner l'assurance que vos exemples compiler & exécuter
    • Il s'intègre très bien dans un ATS de flux de travail
    • À l'aide de \extrait de code est juste ce dont j'ai besoin. J'ai trouvé que je reçois une boîte vide avec aucun code à chaque fois que je comprennent un \brève description de l'élément que je veux joindre un \extrait de.
    • A-ha! mais à l'aide d'un \section pour ajouter un titre me permet d'inclure la \brève trop.
    InformationsquelleAutor Deimos
  3. 1

    J'ai eu des erreurs à l'aide de @exemple, pour inclure le fichier d'exemple dans la documentation. C'est la solution que j'ai utilisée.

    Place examplefile.cs dans un dossier/projet spécifiquement pour l'exemple de code.
    Placer ce dossier dans le Doxygen EXCLUDE liste (Expert->Input->EXCLUDEin Doxygen autre interface) et dans le EXAMPLE_PATH (Expert->Input->EXAMPLE_PATH dans Doxygen autre interface)

    Place de ce bloc de code quelque part dans un dossier documenté (je l'ai mis dans le fichier de l'exemple est pour l'.)

    /** @example examplefile.cs
 * A description of the example file, causes the example file to show up in 
 * Examples */

    Cela provoque le fichier de sous Exemples dans le Doxygen menu, mais pas comme une classe/fichier dans votre projet.

    Puis d'un document de votre classe/fonction:

    /** @brief MyClass does something
 * @details I have something more long winded to say about it.  See example 
 * in examplefile.cs: @include examplefile.cs */

    Cela provoque l'exemple de fichier pour l'imprimer dans son intégralité dans la documentation de MyClass.

    InformationsquelleAutor Denise Skidmore
  4. 1

    1. ajouter un moyen de doxyfile
      EXAMPLE_PATH = dir_example \

    2. permet de connecter tous les exemples dans le même fichier, par exemple example_list.h
      et l'inclure dans doxyfile
      INPUT = example_list.h \

    (langue russe)
    http://www.scale-tech.ru/SimBookmaker/doc/html/examples__list_8h_source.html
    et
    http://www.scale-tech.ru/SimBookmaker/doc/html/examples.html

    InformationsquelleAutor Denis