Sandcastle September 2007 Release: VersionBuilder

  Sandcastle September 2007 release includes the VersionBuilder tool under \ProductionTools folder to provide support for documenting multiple versions of a project. The VersionBuilder tool generates a single reflection data file from multiple version-specific reflection files. The output reflection file can then be used in the Sandcastle build to generate reference documentation in which each…

3

September 2007 Sandcastle release: Generating Framework Reflection data for resolving links

  Sandcastle September 2007 release was shipped without the Framework reflection data. This allowed us to reduce the Sandcastle installer size to 1.5 MB. In our previous releases we shipped the reflection files under the \Data\Reflection folder. For the September release we expect the users to generate this information.   Why do we need this…

4

Componentization – Building Assembly level HxS using Sandcastle

The primary goal of componentization is to reduce the size of a run-time image. In addition to helping meet space requirements, componentization has the following benefits:  Performance – Reducing disk and memory use can significantly improve performance of both the platform and your software. Reliability – As a general rule, reliability increases with fewer executable…

3

Introducing a new document model design code named "Hana"

With Sandcastle June CTP we are releasing a new documentation design code named “Hana”. We expect the release to be available on June 18, 2007. This presentation layer will be released as a part of Sandcastle and will not be used for Orcas documentation shipping in MSDN anytime soon as we have to make changes…

9

The "Prototype" document model design overview

When we released Sandcastle last July we released it with the “Prototype” document model design. The ‘Prototype” document model was designed with the following ideas: 1.    Don’t segregate members by visibility 2.    Don’t segregate – Filter 3.    Don’t Separate a Type from its Members 4.    Better (Chicken Feet) Navigation 5.    Tabbed Language Filtering 6.    True…

0

BuildAssembler Configuration

In my previous blogs I have discussed the architecture of BuildAssembler, a configurable build component stack of Sandcastle. As each topic is build, it is represented as an in-memory XML document. The document is passed through a stack of build components, each of which can act on the document in any way. The component stack…

2

Video of Sandcastle session from MVP Global summit

Microsoft Most Valuable Professionals (MVPs) are exceptional technical community leaders from around the world who are awarded for voluntarily sharing their high quality, real world expertise in offline and online technical communities. Microsoft MVPs are a highly select group of experts that represents the technical community’s best and brightest, and they share a deep commitment…

3

Sandcastle Performance improvements in February CTP

David Smith made some great observations regarding Sandcastle perf. issues on large assemblies at http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=1125897&SiteID=1. We have been testing our code on Phoenix (http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=1125897&SiteID=1) assemblies and here is what we found:   Prototype Style VS2005 Style Topic number 22289 32414 One big reflection file 6mins 16mins One reflection file per assembly 5mins 13mins One reflection…

5

A (Microsoft) code name a day: Sandcastle

I was thrilled to see Mary Jo Foley, from ZDNet, blog about Sandcastle at her “Microsoft Codenames” page. I met Mary at TechEd 2006 in Boston when my team was presenting a chalk talk on MSDN Wiki. I remember asking her after our talk to blog on MSDN Wiki.   Mary had the following about…

3

Supporting Custom tags in Sandcastle

Sandcastle supports C# (and VB) xml tags for developer documentation comments. The list of c# tags are available at http://msdn2.microsoft.com/en-us/library/5ast78ax.aspx. We added the following new custom nDoc tags in November CTP (http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en):   1.            <overloads> 2.            <preliminary> 3.            <threadsafety> 4.            <note>   These custom tags are supported in nDoc and you can see the tags…

10