Utilisation de @voir ou @lien dans doxygen

J'ai documenté avec Javadoc avant et utilisé les balises @see, @link ou {@see foo} et {link foo} dans ma description de lier à d'autres classes. Maintenant, j'ai essayé de doxygen et il semble que ces balises sont incompatibles. Si je lance doxygen complète des balises sont simplement être interprété comme du texte normal.

Il y a un autre balises que je peux utiliser pour obtenir les mêmes fonctionnalités?

stack.nl/~dimitri/doxygen/commands.html Il semble que les deux @see et @link sont pris en charge.
Autant que je sache, ces balises sont pris en charge.
Entre la description aussi?
Il serait utile si vous pouviez inclure des exemples de code et de la documentation et de la doxygen sortie. Cela va nous aider à aller au fond de votre problème.

OriginalL'auteur FredFloete | 2012-08-16

  1. 4

    Lier à d'autres classes, vous devez utiliser le ref de commande. Vous pouvez utiliser le \link de commande, mais vous devez mettre fin à votre texte de lien avec le \endlink de commande, ce qui je pense est votre problème (bien que sans exemple, la documentation, je ne peux pas être sûr).

    De la doxygen section du manuel sur liaison automatique, je vous suggère de lire, il y a un paragraphe sur les liens pour les classes:

    Tous les mots dans les documents qui correspondent à une documentation de classe et contenir au moins un non-minuscule personnage sera automatiquement remplacé par un lien vers la page contenant la documentation de la classe. Si vous voulez éviter qu'un mot qui correspond à une documentation de classe est remplacé par un lien, vous devriez mettre un % devant le mot. Un lien vers un bas de casse symbole, utilisez \ref.

    Quelques points à considérer:

    • Doxygen accepte la \see (qui est synonyme de \sa) et \link commandes. Si elles ne fonctionnent pas comme prévu, l'OP devrait inclure de l'exemple de la documentation que vous nous pouvez essayer et cela ne fonctionne pas comme prévu.

    • La notation {\command description}, avec la enfermant { et } n'est pas commun dans la documentation doxygen, je ne suis pas sûr de savoir comment le programme va traiter ces, alors il est probablement préférable de ne pas utiliser ce style.

    J'ai résolu le problème, ou mieux travaillé autour d'elle. J'utilise la normale JavaDoc Balises comme {@link #onCreate(Bundle)} ou {@link Content} si c'est une classe de ma propre. Documenter ou à l'arbitrage pour android les méthodes et les classes ne fonctionnent pas correctement. Il n'y a pas de liens affichées. J'ai les mêmes problèmes dans la JavaDoc trop donc j'ai décidé d'ajouter <a href="http://developer.android.com/reference/android/app/Activity.html">Activity</a> dans le texte au lieu de {@link Activity}.
    Si vous souhaitez lier à l'encontre de l'Android à la documentation, vous pouvez consulter mon android23.tag de fichier. Qui fournit tous les liens vers la documentation officielle.

    OriginalL'auteur Chris