Doxygen C#XML注释和泛型不会在HTML输出中生成链接

时间:2012-10-01 09:40:42

标签: c# documentation doxygen xml-comments

我在网上找不到任何关于doxygen的XML评论支持的相当无知。

我的问题很简单:

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

在我看来,这是在XML注释中引用开放泛型的正确方法,不会在doxygen输出中生成链接。它只是将文本从cref属性复制到输出。

我知道使用GenericClass<TTypeParam>链接到泛型可以在自定义页面中使用doxygen。那么这是一个已知的错误,还是我错过了一些明显的错误?

顺便说一下。我正在使用doxygen 1.8.2

2 个答案:

答案 0 :(得分:0)

Doxygen目前不支持cref内部的{..}语法。您可以将此视为一个错误。请随意在doxygen的bug追踪器中提交错误报告。

答案 1 :(得分:0)

Doxygen目前似乎没有一种处理泛型的好方法(在1.8.8中) - 除非你乐于忘记标准的Microsoft支持的XML格式(使用{。 ..}语法)并切换到使用&#34; GenericClass&#34;或&#34; \ ref GenericClass&#34; (这两者当然是Visual Studio工具赢得的无效XML)。

请参阅doxygen错误https://bugzilla.gnome.org/show_bug.cgi?id=738173https://bugzilla.gnome.org/show_bug.cgi?id=738167https://bugzilla.gnome.org/show_bug.cgi?id=704090