XML-комментарии и дженерики Doxygen C# не генерируют ссылки в выводе HTML

Я ничего не мог найти в сети, и я совершенно не разбираюсь в поддержке XML-комментариев в doxygen.

Моя проблема проста:

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

Мне кажется, что это правильный способ ссылки на открытый универсальный код в XML-комментариях, который не создает ссылку в выводе doxygen. Он просто копирует текст из атрибута cref в вывод.

Я знаю, что ссылка на дженерики работает в doxygen с пользовательских страниц с помощью GenericClass<TTypeParam>. Так это известная ошибка или я пропустил что-то очевидное?

Кстати. Я использую Doxygen 1.8.2


c# documentation xml-comments doxygen
person sanosdole    schedule 01.10.2012    source источник

Ответы (2)


arrow_upward
0
arrow_downward

В настоящее время Doxygen не поддерживает синтаксис { .. } внутри cref. Вы можете рассматривать это как ошибку. Не стесняйтесь отправлять отчет об ошибке в системе отслеживания ошибок doxygen.

person doxygen    schedule 02.10.2012
comment
Есть ли концептуальная проблема или это просто недостающая функция? - person sanosdole; 03.10.2012
comment
Это недостающая функция. Это уже должно работать, если вы используете \ref вместо XML-эквивалента. - person doxygen; 03.10.2012
comment
Спасибо. Мы используем версию xml из-за поддержки навигации в Visual Studio. - person sanosdole; 03.10.2012

arrow_upward
0
arrow_downward

У Doxygen просто нет хорошего способа обрабатывать дженерики на данный момент (в 1.8.8) - если только вы не готовы забыть стандартный поддерживаемый Microsoft формат XML (который использует синтаксис {...}) и переключиться к использованию "GenericClass" или "\ref GenericClass" (оба из которых, конечно, являются недопустимым XML, который не понравится инструментам Visual Studio).

См. ошибки doxygen 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

person Ben Spiller    schedule 18.12.2014