{"action":"created","issue":{"url":"https://api.github.com/repos/domaindrivendev/Swashbuckle/issues/166","labels_url":"https://api.github.com/repos/domaindrivendev/Swashbuckle/issues/166/labels{/name}","comments_url":"https://api.github.com/repos/domaindrivendev/Swashbuckle/issues/166/comments","events_url":"https://api.github.com/repos/domaindrivendev/Swashbuckle/issues/166/events","html_url":"https://github.com/domaindrivendev/Swashbuckle/issues/166","id":54957461,"number":166,"title":"XML doc comments do not render proper HTML","user":{"login":"tillig","id":1156571,"avatar_url":"https://avatars.githubusercontent.com/u/1156571?v=3","gravatar_id":"","url":"https://api.github.com/users/tillig","html_url":"https://github.com/tillig","followers_url":"https://api.github.com/users/tillig/followers","following_url":"https://api.github.com/users/tillig/following{/other_user}","gists_url":"https://api.github.com/users/tillig/gists{/gist_id}","starred_url":"https://api.github.com/users/tillig/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tillig/subscriptions","organizations_url":"https://api.github.com/users/tillig/orgs","repos_url":"https://api.github.com/users/tillig/repos","events_url":"https://api.github.com/users/tillig/events{/privacy}","received_events_url":"https://api.github.com/users/tillig/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-01-20T23:45:16Z","updated_at":"2015-01-20T23:53:25Z","closed_at":null,"body":"XML doc comments [can sometimes include additional tags](https://msdn.microsoft.com/en-us/library/5ast78ax.aspx) that need to be translated into HTML markup. For example, this...\r\n\r\n```csharp\r\n/// <remarks>\r\n/// <para>\r\n/// There's a little <c>inline code</c> here.\r\n/// </para>\r\n/// <para>\r\n/// This is a list of information.\r\n/// </para>\r\n/// <list type=\"bullet\">\r\n/// <item>\r\n/// <term>First Item</term>\r\n/// </item>\r\n/// <item>\r\n/// <term>Second Item</term>\r\n/// </item>\r\n/// </list>\r\n/// </remarks>\r\n```\r\n\r\n...should be translated into this:\r\n\r\n```html\r\n<p>\r\nThere's a little <code>inline code</code> here.\r\n</p>\r\n<p>\r\nThis is a list of information.\r\n</p>\r\n<ul>\r\n<li>First Item</li>\r\n<li>Second Item</li>\r\n</ul>\r\n```\r\n\r\nThis sort of thing becomes problematic when including XML API documentation directly into the Swagger docs - it renders all wrong, sometimes hiding information (because the browser doesn't know, say, what a `<c>c tag</c>` is) and that isn't so great.\r\n\r\nThe XML API doc inclusion should support rough HTML translation with at least [the standard set of C# doc elements](https://msdn.microsoft.com/en-us/library/5ast78ax.aspx)."},"comment":{"url":"https://api.github.com/repos/domaindrivendev/Swashbuckle/issues/comments/70759175","html_url":"https://github.com/domaindrivendev/Swashbuckle/issues/166#issuecomment-70759175","issue_url":"https://api.github.com/repos/domaindrivendev/Swashbuckle/issues/166","id":70759175,"user":{"login":"tillig","id":1156571,"avatar_url":"https://avatars.githubusercontent.com/u/1156571?v=3","gravatar_id":"","url":"https://api.github.com/users/tillig","html_url":"https://github.com/tillig","followers_url":"https://api.github.com/users/tillig/followers","following_url":"https://api.github.com/users/tillig/following{/other_user}","gists_url":"https://api.github.com/users/tillig/gists{/gist_id}","starred_url":"https://api.github.com/users/tillig/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tillig/subscriptions","organizations_url":"https://api.github.com/users/tillig/orgs","repos_url":"https://api.github.com/users/tillig/repos","events_url":"https://api.github.com/users/tillig/events{/privacy}","received_events_url":"https://api.github.com/users/tillig/received_events","type":"User","site_admin":false},"created_at":"2015-01-20T23:53:25Z","updated_at":"2015-01-20T23:53:25Z","body":"**Let me know if this is something interesting to include in the project.** I already have [a reasonable body of code](https://code.google.com/p/cr-documentor/) that does this sort of conversion that I could adapt for this purpose and submit a pull request. The [NuDoc package might also help here](http://www.nuget.org/packages/NuDoc/) since it already allows reading the XML doc files into an in-memory structure.\r\n\r\nBut I won't go to the effort if it's not interesting to include."}}