Стилизация закодированного текста в сгенерированном Doxygen HTML - PullRequest
0 голосов
/ 31 января 2019

Я генерирую некоторую документацию по API из кода C # с помощью Doxygen.

XML-комментарии выглядят так:

/// <summary>
/// Some summary text.
/// </summary>
/// <remarks>
/// Some remarks.
/// </remarks>
/// <param name="type">Type param</param>
/// <param name="id">ID param</param>
/// <response code="200"> OK</response>
/// <response code="400"> Bad Request</response>
/// <response code="500"> Internal Server Error</response>

Генерируемый Doxygen HTML для строк кода ответа выглядит следующим образом:

<p>&lt;response code="200"&gt; OK&lt;/response&gt; &lt;response code="400"&gt; Bad Request&lt;/response&gt; &lt;response code="500"&gt; Internal Server Error&lt;/response&gt; </p>

Итак, строки кода ответа отображаются на сгенерированной странице следующим образом:

<response code="200"> OK</response> <response code="400"> Bad Request</response> <response code="500"> Internal Server Error</response>

Когда я хочу, чтобы они отображались следующим образом:

<response code="200"> OK</response>
<response code="400"> Bad Request</response>
<response code="500"> Internal Server Error</response>

Мымы не можем изменить способ форматирования кодов ответов в комментариях XML, поскольку наш инструмент Swagger использует этот формат.

  • Я не могу использовать псевдоним, потому что он не может сделатьтекстовые совпадения.Это должно быть что-то вроде \ response или @ response.
  • Я пытался вставить некоторые разрывы, используя собственный CSS, но это не работает, так как мы имеем дело с закодированным текстом.
  • Я такжепопытался заставить его отображать как HTML5, используя собственный заголовок HTML, но это тоже не имело значения.

1 Ответ

0 голосов
/ 01 февраля 2019

Мне кажется, проблема в том, что не распознается как допустимая xml команда от doxygen.Но вы можете попробовать добавить псевдоним в вашу конфигурацию doxygen, которая преобразует в выходной формат по вашему выбору.

...