CODEWITHSUNDEEP
c#documentationdocumentation-generationsandcastle
amateur
amateur

Reputation: 44605

generate sandcastle documentation for c# solution

I have a vs2012 solution that has a number of C# projects. I would like to generate some documentation using Sandcastle for the entire library.

I have been reviewing Sandcastle documentation and not clear how I could generate the documentation for entire project.

How could I achieve this for the entire solution?

Upvotes: 2

Views: 3385

Answers (2)

Michael Sorens
Michael Sorens

Reputation: 36688

As ChrisW indicated, you should use Sandcastle Help File Builder (SHFB). However, even with the clean and simple GUI provided by SHFB, however, there are quite a number of issues that you may need or want to consider in order to produce a tidy, professional documentation set. My article ("Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code") documenting my experience with a variety of potential pitfalls, published on Simple-Talk.com, may save you some time, effort, and agony :-).

Once you have digested the article, and perhaps of more interest, I put a complete syntax and usage guide to SHFB and Sandcastle on this one-page wallchart, available on Simple-Talk.com. Here's a glimpse:

enter image description here

Upvotes: 2

ChrisW
ChrisW

Reputation: 56083

I used Sandcastle Helpfile Builder (instead of using Sandcastle directly).

In a SHFB project, you can specify multiple DLLs+XMLs in the <DocumentationSources> section.

Upvotes: 3

Related Questions