在Doxygen生成的HTML中设置编码文本的样式

时间:2019-01-31 20:58:17

标签: c# doxygen

我正在使用Doxygen从C#代码生成一些API文档。

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插入一些中断,但是由于我们正在处理编码后的文本,因此该行不通。
  • 我还尝试使用自定义HTML标头强制将其呈现为HTML5,但这也没有区别。

1 个答案:

答案 0 :(得分:0)

我认为问题在于被doxygen识别为无效的Firestore pricing page。但是您可以尝试将xml command添加到doxygen配置中,以将转换为您选择的输出格式。