Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to add line break to Swashbuckle documentation?

I'm generating documentation for an api implemented in Web Api 2 using swagger/swashbuckle.

The only xml documentation tags recognized are the <summary>, <remarks> and <param>.
This means I cannot use <para> tag to format my text in new lines or paragraphs, everything is generated as a continuous long paragraph in the Implementation Notes entry of the docs.

Is there any way to do this?

like image 308
Attila Szasz Avatar asked Sep 14 '15 07:09

Attila Szasz


1 Answers

I found that you can just add <br /> tags to the comments to achieve this.
Adding:

/// <br /> 

will cause a line break in the generated documentation.

like image 74
Attila Szasz Avatar answered Oct 20 '22 20:10

Attila Szasz