Doxygen C # XML Комментарии и дженерики не генерируют ссылки в HTML-выходе
-
12-12-2019 - |
Вопрос
Я не мог найти ничего о сетевой сети, и я совсем не невероятно поддержать комментарий XML в Doxygen.
Моя проблема так же просто, как это:
/// <see cref="GenericClass{TTypeparam}"/>
.
Что мне кажется правильным способом ссылаться на открытый универсальный в XML комментариев, не вызывает ссылку на выходе Doxygen.Он просто копирует текст из атрибута CREF на вывод.
Я знаю, что связывание к дженерам работает в Doxygen с пользовательских страниц с помощью GenericClass<TTypeParam>
.Так это известная ошибка, или я пропустил что-то очевидное?
кстати.Я использую Doxygen 1.8.2
Решение
doxygen не поддерживает синтаксис {..} внутри CREF в данный момент.Вы могли бы рассмотреть это как ошибку.Не стесняйтесь отправлять отчет об ошибках в Bug Tracker Doxygen для этого.
Другие советы
Doxygen просто не имеет хорошего способа обрабатывать дженерики в данный момент (в 1.8.8) - если вы не рады забыть стандартный формат XML Microsoft, поддерживаемый Microsoft (который использует синтаксис {...}) и переключитесь на использование «Genericclass» или «\ Ref Genericclass» (оба из которых, конечно, неверны, неверный XML, что приспособление Visual Studio не понравится).
См. Видите в joxygen Bugs https://bugzilla.gnome.org/show_bug.cgi?id= 738173 , https://bugzilla.gnome.org/show_bug.cgi?ID= 738167 и https://bugzilla.gnome.org/show_bug.cgi? ID= 704090