Windows Live Alerts Sandcastle - Site Home - MSDN Blogs

Sandcastle

Documentation compilers for managed class libraries

Blog - About

About Sandcastle

<?xml:namespace prefix = st1 ns = "urn:schemas-microsoft-com:office:smarttags" /><st1:place w:st="on">Mission</st1:place> Statement:<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" /><o:p></o:p>

Enabling managed class library developers throughout the world to easily create accurate, informative documentation with a common look and feel<o:p></o:p>

Overview<o:p></o:p>

Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments. Sandcastle has the following key features:<o:p></o:p>

  • Works with or without authored comments <o:p></o:p>
  • Supports Generics and .NET Framework 2.0 <o:p></o:p>
  • Sandcastle has 2 main components (MrefBuilder and Build Assembler) <o:p></o:p>
  • MrefBuilder generates reflection xml file for Build Assembler <o:p></o:p>
  • Build Assembler includes syntax generation, transformation..etc <o:p></o:p>
  • Sandcastle is used internally to build .Net Framework documentation <o:p></o:p>

<o:p> </o:p>

System Requirements<o:p></o:p>

Supported Operating Systems: <o:p></o:p>

Windows Server 2003; Windows XP Service Pack 2<o:p></o:p>

Required Software: <o:p></o:p>

Microsoft .NET Framework Version 2.0, available here <o:p></o:p>

HTML Help Workshop<o:p></o:p>

Optional Software: <o:p></o:p>

Visual Studio 2005 or Visual Studio SDK<o:p></o:p>

 

Support<o:p></o:p>

Please post all Sandcastle related questions and discussions at http://forums.microsoft.com/MSDN/ShowForum.aspx?ForumID=66&SiteID=1. <o:p></o:p>

 <o:p></o:p>

You can also send feedback and bugs to sandchlp@microsoft.com.

 

 

  • Sandcastle

    MRefBuilder (EXE)

    • 12 Comments
    I my previous blog I discussed Sandcastle.config in detail. Sandcastle process uses three executables: MRefBuilder: Reflects over managed assemblies to produce an XML-formatted reflection information file. BuildAssembler: Collates information...
  • Sandcastle

    Sandcastle Configuration (sandcastle.config)

    • 16 Comments
    Overview Sandcastle builds documentation for any managed class libraries. Sandcastle requires the following inputs: A set of managed assemblies (.dlls or .exes) to document The set of assemblies on which the operation of those assemblies depend...
  • Sandcastle

    Joe in Iowa – A Sandcastle Scenario

    • 11 Comments
    This post provides steps to create CHM using Sandcastle. Some of the users have automated these steps. Mikael Söderström has a "Sandcastle Helper" here , Ashley van Gerven has a batch script available here and Scott Hanselman's has power shell script...
  • Sandcastle

    Evolution of Sandcastle

    • 6 Comments
    Thanks for all your comments and feedback about the July CTP. I was away last week at a management training and will get back to all your comments. I also received several emails about Sandcastle and have started getting back them. This forum post had...
  • Sandcastle

    A few faqs about Sandcastle

    • 42 Comments
    I’m super excited about the response to the Sandcastle CTP launch. Much of the response has been positive, and folks have asked some great questions. Let me try to address a few of the common questions people have about the site: Where can post Sandcastle...
  • Sandcastle

    Announcing Sandcastle CTP

    • 35 Comments
    Sandcastle CTP can now be downloaded at http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en Instructions: 1. Visit the above link to download and install Sandcastle. 2. After installing...
  • Sandcastle

    Creating a Chm build using Sandcastle

    • 65 Comments
    Here are the steps to create a Chm build using Sandcastle. Please see the atatchment for the steps in text format. Prerequisites: 1. .Net Framework 2.0 2. For Chm generation download HTML Help Workshop - http://msdn.microsoft.com/library/default...
  • Sandcastle

    Sandcastle Overview

    • 13 Comments
    Attached power point slides provide a high level overview of Sandcastle. I will be posting more design details after we ship the CTP version Anand..
  • Sandcastle

    Announcing Sandcastle

    • 13 Comments
    We will be releasing the CTP version of Sandcastle shortly. There are couple places (download at our download center and also as a part of VS SDK) we are targeting to release our CTP version. Also as soon as the CTP is posted I will provide the information...
Page 5 of 5 (109 items) 12345