Pergunta

Não consegui encontrar nada na net e não tenho a menor ideia do suporte a comentários XML no doxygen.

Meu problema é tão simples quanto isto:

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

O que me parece ser a maneira correta de fazer referência a um genérico aberto em comentários XML, não produz um link na saída do doxygen.Apenas copia o texto do atributo cref para a saída.

Eu sei que vincular a genéricos funciona no doxygen a partir de páginas personalizadas usando GenericClass<TTypeParam>.Então, este é um bug conhecido ou perdi algo óbvio?

Por falar nisso.Estou usando o doxygen 1.8.2

Foi útil?

Solução

Doxygen não suporta o { ..} sintaxe dentro do cref no momento.Você pode considerar isso um bug.Sinta-se à vontade para enviar um relatório de bug no rastreador de bugs do doxygen para isso.

Outras dicas

Doxygen simplesmente não parece ter uma boa maneira de lidar com genéricos no momento (em 1.8.8) - a menos que você queira esquecer o formato XML padrão suportado pela Microsoft (que usa a sintaxe {...}) e mudar ao uso de "GenericClass" ou " ef GenericClass" (ambos são, obviamente, XML inválidos que as ferramentas do Visual Studio não irão gostar).

Veja bugs doxygen https://bugzilla.gnome.org/show_bug.cgi?id=738173, https://bugzilla.gnome.org/show_bug.cgi?id=738167 e https://bugzilla.gnome.org/show_bug.cgi?id=704090

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top