1

I had installed Redoc with NSwag package in my WebApi projects. But I found that a lot of features are not working in the output API documents:

  1. No line break for the summary and remarks tag Sample line break

  2. The tag of Example, code is not showing in the document

/// <example>
/// Example request here
/// </example>

Not sure if it should be work if I follow the tag recommendation from Microsoft?

Because I found that none of the tag is working fine as Redoc samples except "Param", "Returns"

Update:

I tried the set the remarks like this:

/// <remarks>Line1
/// 
/// Line2
/// Line3
/// </remarks>

But it had became:

enter image description here

William Tang
  • 215
  • 1
  • 2
  • 8
  • 1
    `` is treated as plain text, that's probably why line breaks are ignored. `` are Markdown, so you'll need to add 1 or 2 blank lines between the paragraphs because a single line break is handled as line continuation. – Helen Aug 04 '21 at 12:00
  • I just tried it but it became text in black box. – William Tang Aug 05 '21 at 06:59
  • Interesting. Looks like Line2 and Line3 were treated as a code block instead of a paragraph. Can you try other suggestions from [this Q&A](https://stackoverflow.com/q/32559028/113116)? – Helen Aug 05 '21 at 08:54

0 Answers0