Insérer le lien vers la fonction dans un autre fichier avec Doxygen?

J'ai deux fichiers source C. Un commentaire à une fonction bar()dans le fichier A besoin de se référer à une fonction foo() dans le fichier B. Comment puis-je faire ce lien?

J'ai essayé:

  1. Écrit quelque chose comme: B.c::foo() en espérant que doxygen serait aller à fichier B et de trouver la fonction foo là.

  2. Aussi tout simplement essayé de ::foo() mais cela n'a pas aidé.

  3. Ensuite, j'ai essayé de donner le fichier B.c spécial tagname que, dans cette //! @file specialtag sur la première ligne de B.c et ensuite de faire specialtag::foo() dans mon commentaire, mais n'a pas beaucoup changé.

  4. J'ai essayé de forcer le lien avec \ref et \link mais même cela n'a pas aidé.

La //! @file ligne est présente dans les deux A.c et B.c donc doxygen doit être conscient du code.

MODIFIER

J'ai essayé ce que @doxygen suggéré, mais avec pas de chance. J'ai fait un exemple de projet pour montrer où je suis en cours d'exécution dans des problèmes, c'est ici: http://www.filedropper.com/testdoxygen2tar

J'ai utilisé la configuration par défaut du fichier, faite avec doxygen -g.
La sortie j'obtiens:
Insérer le lien vers la fonction dans un autre fichier avec Doxygen?

Vous pouvez voir que le foobar fonction n'est pas liée.

EDIT 2

Trouvé le problème. Fonction foo sans papiers et donc pas de page pour lequel il a été généré, alors, évidemment, doxygen avait pas de page de lien. (J'ai été l'élaboration de la documentation avec la SOURCE_BROWSER option est activée et en espérant qu'un lien vers la définition de fonction serait généré)

  • Le mieux que je peux penser, c'est juste un lien vers le fichier, avec un GRAS note indiquant à l'utilisateur de regarder la fonction lorsqu'ils y sont. Vous pouvez auto-link, ou utilisez @voir. Désolé que ce n'est pas beaucoup d'aide. Je voudrais savoir la réponse moi-même. Si pas de chance ici, alors peut-être vous inscrire et poster votre question à la DoxyGen liste de diffusion des utilisateurs?
InformationsquelleAutor user10607 | 2015-01-16
  1. 5

    C'est assez simple. Voici un exemple minimal, qui fonctionne avec un fichier de configuration par défaut (doxygen -g):

    D'abord créer le fichier foo.c avec le contenu suivant:

    /** @file */

/** Function foo, see also bar(). */
void foo()
{
}

    puis de créer le fichier de la barre.c avec le contenu suivant:

    /** @file */

/** Function bar, see also foo(). */
void bar()
{
}

    Exécuter doxygen et d'observer dans le code HTML de sortie que les deux fonctions ont un lien vers l'autre fonction.

    • J'ai résolu le problème. J'étais la génération de la documentation avec SOURCE_BROWSER option est activée et a été en espérant que le nom d'une fonction me prendrait à sa définition de la source.
    • Vous pouvez définir EXTRACT_ALL sur OUI si vous voulez des espaces réservés à relier à l'absence de documentation de la fonction.
    • Si les deux fonctions ont le même nom?
    • C'est une autre question. Heureusement ça a déjà été demandé :-). de la gestion de deux fonctions différentes avec le même nom dans Doxygen.
    InformationsquelleAutor doxygen