Sandcastle June 2010 Release


I am happy to announce that we have posted an updated version of Sandcastle to Codeplex.  I know this was a very long wait for everyone.

This release brings Sandcastle to parity with the code that was used to generate the Visual Studio 2010 and .NET Framework 4 documentation. It contains over 100 bug fixes and changes that were made over the last 2 years and adds full support for building API documentation for .NET 4 projects.

We also contracted with ComponentOne to add support for producing the Microsoft Help Viewer 1.0 (MSHC) output target. Sandcastle can now produce Xhtml files that can be cabbed up and consumed by the new Microsoft Help System, which was released with Visual Studio 2010.

For our next release, we plan on adding support for the output of topics with the MSDN Lightweight look and feel. For the VS 2010 docs that we shipped, this new styling was added in post-production by MSDN, which is why it isn’t already part of the Sandcastle presentation layers.

Darren Parker
Microsoft

Comments (12)

  1. Darren, thanks for the great work. We are really looking forward for the Lightweight look, since this is the native look of the VS 2010 Help System, and all looking for MSDN help integration will need it.

  2. Sergey says:

    >Samples in the SandcastleExamples folder have been augmented to support MHV target.

    >– To build MSHC target in the 'generic' sample, execute the following command in %DXROOT%Examplesgeneric:

    >   msbuild test.scproj /target:mshc

    >   The output is generated in ..testvs2005output.

    Not find file "..testvs2005output.mshc"

  3. Sergey says:

    Missing <summary> documentation for "M:VectorMathematics.SupplementEnumerable.Integration(System.Collections.Generic.IEnumerable{System.Double},VectorMathematics.DifferentialGeometry.Integrator,System.Func`2)"

    __________________________________________________________________/^

    In XML file:

    M:VectorMathematics.SupplementEnumerable.Integration(System.Collections.Generic.IEnumerable{System.Double},VectorMathematics.DifferentialGeometry.Integrator,System.Func{System.Double,System.Double})

    _________________________________________________________________/^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  4. GermanshepherdGeek says:

    great work!

  5. Amit says:

    Hi, I am getting the following error while generating the help file for an application in vs2010 using .NET Framework 4.0

    Generating reflection information…

    [C:WindowsMicrosoft.NETFrameworkv3.5MSBuild.exe]

    GenerateRefInfo:

     MrefBuilder (v2.6.10621.1)

     Copyright c Microsoft 2006

     Info: Loaded 15 assemblies for reflection and 1 dependency assemblies.

     Unhandled Exception: System.ArgumentException: An item with the same key has already been added.

        at System.ThrowHelper.ThrowArgumentException(ExceptionResource resource)

        at System.Collections.Generic.Dictionary`2.Insert(TKey key, TValue value, Boolean add)

        at Microsoft.Ddue.Tools.ManagedReflectionWriter.VisitNamespaces(NamespaceList spaces)

        at Microsoft.Ddue.Tools.Reflection.ApiVisitor.VisitApis()

        at Microsoft.Ddue.Tools.MRefBuilder.Main(String[] args)

    C:Usersamitkumar_tripathyDocumentsHelpWorkingGenerateRefInfo.proj(35,5): error MSB6006: "MRefBuilder.exe" exited with code -532462766.

       Last step completed in 00:00:05.1324

    ——————————-

    SHFB: Error BE0043: Unexpected error detected in last build step.  See output above for details.

    i also changed the version of the framework in the Sandcastle in the project properties to 4.0 but i am still getting the same error. I have the June release of Sandcastle and the SHFB version of 1.9.1.0

    How do i go about it ?

  6. dgalligher says:

    Current download for Sandcastle seems to only be geared for 2005 version of Visual Studio. I need the download for the VS2010 version – additional help would be appreciated or direction to the proper file would be helpful. Build only offers Presentation Style: vs2005 / hana  / prototype. Every time build executes it fails with the following message on VS2010 .NET 4.0 project:

    The system cannot find the file specified.

    … vssver2.scc

    VS2010 uses mssccprj.scc instead.

  7. jstemper says:

    Is tehre any basic documentation for incorporating SandCastle into the VS2010 IDE?

  8. Winton DeShong says:

    I am receiving the same error as Amit with:

    Generating reflection information…

    [C:WindowsMicrosoft.NETFrameworkv3.5MSBuild.exe]

    GenerateRefInfo:

     MrefBuilder (v2.6.10621.1)

     Copyright c Microsoft 2006

     Info: Loaded 21 assemblies for reflection and 0 dependency assemblies.

     Unhandled Exception: System.ArgumentException: An item with the same key has already been added.

        at System.Collections.Generic.Dictionary`2.Insert(TKey key, TValue value, Boolean add)

        at Microsoft.Ddue.Tools.ManagedReflectionWriter.VisitNamespaces(NamespaceList spaces)

        at Microsoft.Ddue.Tools.Reflection.ApiVisitor.VisitApis()

        at Microsoft.Ddue.Tools.MRefBuilder.Main(String[] args)

    C:ClientsandCultureadeptivplatformadeptiv_docuWorkingGenerateRefInfo.proj(35,5): error MSB6006: "MRefBuilder.exe" exited with code 255.

       Last step completed in 00:00:12.8438

    </buildStep>

    <buildStep step="Failed">

    My documentation _was_ building just fine, but now it fails consistently. Any ideas?

  9. Winton DeShong says:

    Actually, I found the problem. Further up in my build output there was a warning. Somehow a class library was added to the documentation references twice. That explains the duplicate key exception for the dictionary.

  10. Ed says:

    I inherited a firmware project (*.c, *.h) files and would love to document the routines in the project. What would be the best tool? Microsoft HtmlHelp?. Looks like SandCastle won't help me because it uses reflection to get method info, etc. Obviously, C files aren't in the same format as C# files. I suppose I could hand enter /// style comments and see if SandCastle would extract just those elements and build documentation for me.

    Any ideas would be appreciated.

    Ed

  11. Paul says:

    So, any chance of a reasonable explanation on how to use this, without pole-vaulting to the assumption that one is using command-line functions to compile their code??? Some of us actually USE VS's GUI.  I don't shell-script when I'm developing; I'm a DEVELOPER, not a SCRIPTER.  Some of actually write our code and turn off the machine at night, instead of spending our lives with our heads buried in Powershell hacks.

  12. Chris says:

    One of the transforms expects toc.xml and fails. The powershell script is admirable, but even a very basic single form UI would be helpful.

    It feels like this, and NDoc3 over-engineer the problem somewhat. Using XSL for transforms in 2010 still, when Microsoft ditched XSL support in .NET years ago is bizarre.