Take the 2-minute tour ×
Stack Overflow is a question and answer site for professional and enthusiast programmers. It's 100% free, no registration required.

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?

share|improve this question

2 Answers 2

up vote 2 down vote accepted

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:

share|improve this answer

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

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

share|improve this answer

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.
{"cc_re__cc_re__cc_by_sa_3_0": ["        <li><a href=\"http://area51.stackexchange.com\" title=\"proposing new sites in the Stack Exchange network\">Area 51</a></li>\r\n                        <li><a href=\"http://careers.stackoverflow.com\">Stack Overflow Careers</a></li>\r\n                    \r\n                </ol>\r\n            </td>\r\n    </tr>\r\n</table>\r\n                </div>\r\n            </div>\r\n\r\n            <div id=\"copyright\">\r\n                site design / logo &#169; 2014 stack exchange inc; user contributions licensed under <a href=\"http://creativecommons.org/licenses/by-sa/3.0/\" rel=\"license\">cc by-sa 3.0</a> \r\n                with <a href=\"http://blog.stackoverflow.com/2009/06/attribution-required/\" rel=\"license\">attribution required</a>\r\n            </div>\r\n            <div id=\"svnrev\">\r\n                rev 2014.7.30.1736\r\n            </div>\r\n            \r\n        </div>\r\n    </div>\r\n    <noscript>\r\n        <div id=\"noscript-warning\">Stack Overflow works best with JavaScript enabled<img src=\"http://pixel.quantserve.com/pixel/p-c1rF4kxgLUzNc.gif\" alt=\"\" class=\"dno\"></div>\r\n    </nos"], "copyright__copyright__copyright": ["astle on this one-page wallchart, available on Simple-Talk.com. Here's a glimpse:\n\nshare|improve this answer\n\nI used Sandcastle Helpfile Builder (instead of using Sandcastle directly).\n\nIn a SHFB project, you can specify multiple DLLs+XMLs in the <DocumentationSources> section.\n\nshare|improve this answer\n\nYour Answer\n\n\u00a0\ndiscard\n\nBy posting your answer, you agree to the privacy policy and terms of service.\n\nNot the answer you're looking for? Browse other questions tagged or ask your own question."]}