Pregunta

No pude encontrar nada en la red y estoy bastante despistado para el soporte de comentarios XML en Doxygen.

Mi problema es tan simple como este:

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

que me parece ser la forma correcta de hacer referencia a un genérico abierto en los comentarios de XML, no produce un enlace en la salida de Doxygen.Simplemente copia el texto del atributo de CREF a la salida.

Sé que vincular a los genéricos funciona en Doxygen desde páginas personalizadas mediante el uso de GenericClass<TTypeParam>.Entonces, ¿este es un error conocido, o extraño algo obvio?

por cierto.Estoy usando Doxygen 1.8.2

¿Fue útil?

Solución

Doxygen no admite la sintaxis {} dentro del CREF en este momento.Podrías considerar esto como un error.Siéntase libre de enviar un informe de errores en el rastreador de errores de Doxygen para este.

Otros consejos

Doxygen simplemente no parece tener una buena manera de manejar los genéricos en este momento (en 1.8.8), a menos que esté feliz de olvidar el formato XML con soporte de Microsoft estándar (que utiliza {...} Sintaxis) y cambie a usar "GenericClass" o "\ Ref GenericClass" (ambos de los cuales, por supuesto, XML no válidos que no se gustarán las herramientas de Visual Studio).

Consulte Doxygen Bugs https://bugzilla.gnome.org/show_bug.cgi?id= 738173 , https://bugzilla.gnome.org/show_bug.cgi?ID= 738167 y https://bugzilla.gnome.org/show_bug.cgi? ID= 704090

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top