2

I added Help Pages to my Web API project. However most of the documentation does not show on the help pages because:

  1. the objects used as parameter types and return types are defined in a separate assembly/project, and
  2. documentation for the controllers' actions are defined in separate interfaces implemented by the controllers. Also, these interfaces are in a separate assembly/project.

An overview of my solution structure:

  • Web API project
  • Class library with data objects (used as parameter types and return types in controller actions)
  • Class library with controller interfaces (implemented by each controller)

Is it possible for Help Pages to a) incorporate XML documentation from separate projects, and b) apply the XML documentation from an interface to the class that implements it?

Keith
  • 20,636
  • 11
  • 84
  • 125

2 Answers2

0

From the other projects .xml files (in the /bin folder) copy the member collection and paste into your .xml file.

lcryder
  • 486
  • 2
  • 8
  • 1
    This works (contrary to my previous comment) but I'd prefer something that doesn't require manual intervention. I've been looking at [these answers](http://stackoverflow.com/questions/22165724/web-api-help-page-xml-comments-from-more-than-1-files) and they help with the 'separate projects' part of my question, but I still would like to figure out the 'interface' part of my question. – Keith Feb 23 '16 at 02:18
0

I solved this as follows:

  1. To handle XML files from multiple projects I've incorporated the code from this answer. This code essentially does what @lcryder suggested but automatically.
  2. To apply XML documentation from an interface to its implemented class I am using GhostDoc's Document This option to copy the XML documentation.

However I'm not happy with #2 because it requires manual intervention and I have to remember to recopy the XML documentation whenever it changes, so I'm still looking for a better answer.

Community
  • 1
  • 1
Keith
  • 20,636
  • 11
  • 84
  • 125