Question

I installed the ASP.NET Web API Help Page package and would like to use it to generate documentation for my API controller actions using the Xml comments already on them.

I came across an article on Yao’s MSDN blog where he discusses how the documentation can be generated based on the XML comments.

However, in the Register method of HelpPageConfig, the SetDocumentationProvider method expects an instance of XmlDocumentationProvider constructed with a physical path to an Xml documentation file.

Is there another way to do this? I’m not clear why I need to point to an Xml documentation file.

Thanks

Answer 1

The XmlDocumentationProvider is looking for the xml file(having your xml code comments) which gets generated when you compile your project.
You can enable generating this by going to your project Properties -> Build -> Output. Here select the checkbox for XML Documentation file.