What’s new in August 2006 Sandcastle CTP


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:



  1. Firefox support for Sandcasltle generated HTMs
  2. 3 different link options (local, Index and MSDN) in sandcastle.config file.
  3. /internal+- option in MrefBuilder enables documentation of private APIs to be produced for the internal consumption of development teams
  4. Support for multi-dimensional arrays
  5. Support for CHM Index and root node. Additional transforms are added to CHM generation process to accomplish this.
  6. Support for all C# tags and html style elements in code comments
  7. Abilty to use environment variables in config files
  8. Changes to syntax for XSLTransform

Note: Sandcastle users should take note that, as part of the resolution of the XslTransform crash bug, the syntax for XslTransform has changed. To specify an XSLT you use the /xsl option, and to specify multiple XSLTs you specify multiple /xsl options. Thus the old syntax
            XslTransform AddOverloads.xsl reflection.org | XslTransform AddGuidFileNames.xsl /out:reflection.xml


Has now become:
            XslTransform /xsl:AddOverloads.xsl /xsl:AddGuidFileNames.xsl reflection.org /out:reflection.xml


Or, if you prefer:
            XslTransform /xsl:AddOverloads.xsl,AddGuidFileNames.xsl reflection.org /out:reflection.xml


Environment variables are expanded on all input strings. XslTransform no longer supports pipelining.


Bug Fixes:


The following bugs have been fixed for this CTP.



  1. BuildAssembler /?  shows the usage as “TocBuilder” and incorrect information.
  2. XslTransform with no cmd line parameters crashes.
  3. Sandcastle.config file would support environment variables for all paths instead of just some of them.
  4. Typo: Info: ResolveReferenceLinksComponent: Preparing to querry MSDN topic URL web service.    “querry” should be “query”.
  5. Error: An error occured while performing the transofmation. The error message is:…    “transofmation” should be “transformation”.
  6. BuildAssembler: System.Null referenceException being thrown and tool dies for MREF build.
  7. Exception tag from XML comments are not being populated in .chm file.
  8. Sandcastle: CHM compile warnings should be fixed.
  9. Sandcastle: Buildassembler is throwing exception and the resulting CHM has several issues.
  10. Sandcastle losing encoding for localization builds.
  11. Typos in various “error” messages.
  12. Protected members are treated as public and C++ set methods for properties are documented with an extra comma
  13. Sandcastle:Lists are not documented correctly
  14. Sandcastle: Extra brackets in front of every parameter name
  15. Sandcastle – System.NullReferenceException related to interface implementation
  16. Sandcastle: BuildAssembler has a problem with multi-dimensional arrays
  17. Sandcastle: Types are missing
  18. Unhandled exception thrown by XslTransform
  19. Sandcastle is dropping the <paramref name=”blah”/> text
  20. BuildAssembler throws exception during attempt to overwrite a read-only file
  21. Sandcastle: Generated htm files are missing reflection information.
  22. Enable use of environment variables within Manifold BuildAssembler .config files
  23. Sandcastle: Issue with interfaces inheriting from generic interfaces.
  24. Sandcastle transforms does not process all XML elements from code comments
  25. BuildAssembler  throws exception when processing WinSDK dlls

Comments (16)

  1. What’s new in August 2006 Sandcastle CTP Sandcastle blog- August 2006 Sandcastle CTP should be available

  2. andlju says:

    I have updated the MSBuild script for Sandcastle to work with this latest version of the CTP:

    http://blog.ljusberg.com/2006/08/sandcastle-august-ctp-released.html

    /Anders

  3. test says:

    The team behind Microsoft Sandcastle released a new CTP of Sandcastle yesterday. A couple of changes

  4. CoqBlog says:

    La CTP d’Ao&#251;t 2006 de Sandcastle est disponible.

    Au menu, des am&#233;liorations comme :

    le support des…

  5. OK, so maybe you’ve seen it already. But with the demise of NDoc for .Net 2.0 there is, to me at least,

  6. Rob Caron says:

    You may recall a release in July of the first Sandcastle CTP (Sandcastle – Documenting Managed Class…

  7. SteffenJ says:

    I use danish characters in my code documentation. These characters do not show correct in the .htm or .chm files. How do I set localization?

    SteffenJ

  8. aram says:

    Steffen,

    Could you email me you comment XML file with DAnish charecters? I would like to debug to see what the issue is. Thanks.

    Anand..

  9. SteffenJ says:

    Hi Anand.

    Where can I find your email address?

    I have made an example file but if possible, you can try to use the ALT key and the numeric keyboard with these codes:

    æ ALT+145   Æ ALT+146

    ø ALT+155    Ø ALT+157

    å ALT+134    Å ALT+143

    Thanks very much

    SteffenJ

  10. aram says:

    Thanks Steffen. You can use the "Email" link at the top of this web page to reach me. My address is AramATMicrosoftDotCom.

    Anand..

  11. SteffenJ says:

    Hi again.

    I have downloaded Sandcastle Help File Gui from http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=641182&SiteID=1

    It has a Language property that can be set to Danish/Denmark and that solves my problem.

    Thanks for your help

    SteffenJ

  12. Smöråkning says:

    The team behind Microsoft Sandcastle released a new CTP of Sandcastle yesterday. A couple of changes

  13. For a *long* time, whenever I spent time with C# customers, I would invariably get asked, &quot;How do I create…

  14. CoqBlog says:

    La CTP d’Août 2006 de Sandcastle est disponible . Au menu, des améliorations comme : le support des tableaux