asp.net-web-apiswaggerswagger-uiline-breaksswashbuckle

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?


Solution

  • Another way to achieve is creating a custom OperationFilter and use the xml documentation tags as explained in :

    https://github.com/domaindrivendev/Swashbuckle/issues/258

    Hope this helps

    Sam