giraffe-fsharp / Giraffe

A native functional ASP.NET Core web framework for F# developers.

Home Page:https://giraffe.wiki

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

XML Docs don't appear to be working

isaacabraham opened this issue · comments

Maybe this is a Rider thing? I'm just trying a codebase and getting no documentation for any Giraffe symbols e.g. for the route function this is what I see in Rider:

image

However if I go to definition I indeed do see there's proper XML Docs on the value:

image

I've tested out local functions and regular /// and full XML Doc stuff seems to be working just fine. I would expect to see the following in Rider (I just copied the implementation above into my project including the docs).

image

How do you view the documentation? When I hover with my mouse over a Giraffe function in Rider then I get the docs shown like this:

image

Any updates here?

rider, the latest version
XML commets are ok

image

Thanks for confirming @Trigun27

Sorry - I've just tested and can confirm that it's all working now. I had feared it was that the docs weren't being bundled in the NuGet package but it appears that it was a Rider thing.