Question

Je n'ai rien trouvé sur le net et je n'ai aucune idée de la prise en charge des commentaires XML dans doxygen.

Mon problème est aussi simple que ceci :

/// <see cref="GenericClass{TTypeparam}"/>

Ce qui me semble être la bonne façon de référencer un générique ouvert dans les commentaires XML, ne produit pas de lien dans la sortie de doxygen.Il copie simplement le texte de l'attribut cref vers la sortie.

Je sais que les liens vers des génériques fonctionnent dans doxygen à partir de pages personnalisées en utilisant GenericClass<TTypeParam>.Alors, est-ce un bug connu ou ai-je raté quelque chose d'évident ?

D'ailleurs.J'utilise doxygen 1.8.2

Était-ce utile?

La solution

Doxygen ne prend pas en charge le { ..} syntaxe dans cref pour le moment.Vous pourriez considérer cela comme un bug.N'hésitez pas à soumettre un rapport de bug dans le tracker de bugs de doxygen pour cela.

Autres conseils

Doxygen ne semble tout simplement pas avoir un bon moyen de gérer les génériques pour le moment (dans la version 1.8.8) - à moins que vous ne souhaitiez oublier le format XML standard pris en charge par Microsoft (qui utilise la syntaxe {...}) et changer à l'utilisation de "GenericClass" ou " ef GenericClass" (qui sont bien sûr des fichiers XML invalides que les outils Visual Studio n'apprécieront pas).

Voir les bugs de Doxygen https://bugzilla.gnome.org/show_bug.cgi?id=738173, https://bugzilla.gnome.org/show_bug.cgi?id=738167 et https://bugzilla.gnome.org/show_bug.cgi?id=704090

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top