Self documenting asp.net api

Question

I created an Asp.net api in VS2015. Inside the Areas>HelpPage>App_Start>HelpPageConfig.cs I uncommented line 37

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

There was no XmlDocument.xml in the App_Data folder for the project so I created one with the tags I'd seen in self documenting xml's in other apis

<?xml version="1.0" encoding="utf-8" ?>
<doc>
  <assembly>
    <name>NameOfApiHere</name>
  </assembly>
  <members>
  </members>
</doc>

but when building and/or running the application nothing is going into the xml. It's my understanding that when this is turned on the XML sel documents based on each ///summary for a given method with an intellisense alert for any public method that does not have a summary but I cna't find any code that would explicitly copy summary information to this xml as "member" tags inside of teh "members" tag nor is it happening. What step am I missing that I'm not seeing in the how to's on the internet for turning on self documentation in an APi?

ASpirin · Accepted Answer · 2017-07-31 19:56:02Z

1

In project propeties repoint XML documentation destintion folder to your desired folder. I suppose it would be better to use app_data instead of App_code folder.

take a look into 1st and 2nd steps of this question answer

answered Jul 31, 2017 at 19:56

ASpirin

3,6711 gold badge26 silver badges33 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

davidp04 Over a year ago

This led me to it, it was in the properties unter build, I had to both check "XML Documentation file:" and set the path to my xml

ASpirin Over a year ago

did you tried change folder to app_data? In any case XmlDocumentationProvider is in your project Debug it and you'll see why it's not working

davidp04 Over a year ago

yes, it is in App_data, the App_Code was a typo in the question that I will correct

David Bettis · Accepted Answer · 2017-07-31 19:57:28Z

0

Try deleting the XmlDocument.xml file that you added (I think this autogenerates) and specify the path to it in the project settings -> Build tab inside the Output section.

answered Jul 31, 2017 at 19:57

David Bettis

745 bronze badges

Collectives™ on Stack Overflow

Self documenting asp.net api

2 Answers 2

3 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related