How to add Sandcastle documentation to builds

Mark Edwards

Sandcastle is a tool developed by Microsoft which builds MSDN-style help files by using reflection and XML comments from the source code of a project. Documentation for other dlls are set for auto generation. Is there some documentation on how to set this up for a project? Or does someone have some experience doing this?

mark.maruska

The CM team should be able to help with the build aspect. For the code setup aspect, I found that adding a **DocumentationSource** entry for your project in the Sandcastle project file (*.shfbpro) is the way to tell Sandcastle which projects to generate docs for. Here's an existing example (for AppLibrary projects): - TFS: $/Cobalt Product Tech/Development/AppLibrary/Projects/Help/AppLibraryHelp.shfbpro - Output: [Cobalt .NET AppLibrary - Table of Contents](
http://eg-cbbld-b012.tlr.thomson.com/AppLibraryHelp/) Also, this [Sandcastle Setup](
http://nsawiki.int.westgroup.com/wiki/index.php5/Sandcastle_Setup) documentation may be helpful too.