Generating separate help topics with same class/member details but in different format

Topics: User Forum
Nov 26, 2011 at 10:39 AM
Edited Nov 26, 2011 at 10:51 AM

Hi,

We are using Sandcastle to produce API doco for our web services. As part of the doco we want to be able to produce separate conceptual topic files for high level busines users which describe the actual web service method interfaces. The information in the topic files we want based on the same class/member comments in the API doc but expressed in a different format.

For example in the topic files we want have a table each to describe the request and response types of a web service method which has a signature MyResponse MyMethod(MyRequest request). We want to list all the members by traversing the classes properties and produce the output in a hierarchical form (with indenting). In the output we want a column for the data type and a column for the comments.

MyRequest

 Name

   Type

Description

PropertyX

 MyType

 

    -  PropertyY

 String

 

     - PropertyZ

 Int32

 

PropertyA

 String

 

MyResponse

 Name

   Type

Description

PropertyD

 MyType

 

    -  PropertyE

 String

 

     - PropertyF

 Int32

 

PropertyG

 String

 

What is the best way to acheiving the above with SHFB?

Coordinator
Nov 26, 2011 at 8:55 PM

There isn't a way to do what you want with Sandcastle or SHFB by default.  You'll most likely need to write a plug-in for SHFB that parses the reflection and/or XML comments files and produces MAML topics that are added dynamically to the project at build time.  The other alternative is to write a tool that runs outside of the Sandcastle/SHFB build process to generate the topics ahead of time.

Eric