Windows Live Alerts August, 2006 - Sandcastle - Site Home - MSDN Blogs

Sandcastle

Documentation compilers for managed class libraries

August, 2006

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

    Resolving reference links in Sandcastle using none, local, index and msdn link type options

    • 9 Comments
    Sandcastle supports 4 different link type options. The link type options are defined in sandcastle.config file under ResolveReferenceLinks component. The 4 different type options under this component are the following: none - Results in text with...
  • Sandcastle

    What's new in August 2006 Sandcastle CTP

    • 16 Comments
    August 2006 Sandcastle CTP is currently available at http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&DisplayLang=en . Here is a summary of what's new in this CTP version: Firefox support for Sandcasltle...
  • Sandcastle

    Launching sandcastledocs.com wiki site

    • 6 Comments
    Molly Bostic, program manager, MSDN Wiki and a member of my team helped me last night to setup Sandcastledocs.com sharepoint wiki website. Thanks Molly J It’s available at http://www.sandcastledocs.com with links to Sandcastle download, blogs, forums...
  • Sandcastle

    Sandcastle for Documentation Build

    • 7 Comments
    Installation and Layout Sandcastle CTP can be downloaded from http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en Instructions: Visit the above link to download and install...
  • Sandcastle

    Syntax Generation

    • 1 Comments
    Syntax in Sandcastle documentation is generated by SyntaxBuilder. SyntaxBuilder uses the Common Compiler Infrastructure (CCI) library to reflect over a set of managed assemblies and produce syntax blocks that represent each API in various languages. SyntaxBuilder...
  • Sandcastle

    BuildAssembler (EXE)

    • 5 Comments
    I my previous blog s I discussed MrefBuilder and Sandcastle.config in detail. Sandcastle process uses three executables: MRefBuilder: Reflects over managed assemblies to produce an XML-formatted reflection information file. BuildAssembler: Collates...
  • 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...
Page 1 of 1 (10 items)