sandcastle

adding class diagrams from VS2008 to Sandcastle help file

I've made class diagrams for my projects in Visual Studio 2008 Team System and I want to embed these diagrams in my Sandcastle .chm file. I keep finding references to the Drawbridge component for Sandcastle but they apparently dealt with an older version of Sandcastle; not surprising since it looks like Drawbridge was last updated in 20...

MRefBuilder invalid character exception on SandCastle

I'm trying to use the Sandcastle Help File Builder to generate a help file for my assembly. When I run the build I get the following error: MrefBuilder (v2.4.10520.1) Copyright c Microsoft 2006 Info: Loaded 1 assemblies for reflection and 15 dependency assemblies. Unhandled Exception: System.ArgumentException: '', hexadecimal va...

Documenting using Sandcastle: Refering to enum value using <see>

I'm using Sandcastle 2.4.10520 and Sandcastle Help File Builder 1.8.0 to generate a .chm help file. In my documentation, I'm using <see> tags. If I try to refer an enum like <see cref="NumberStyles"/> it works perfectly. If I try to refer an enum value like <see cref="NumberStyles.AllowTrailingWhite"/> I get a link in the documentatio...

Multiple language examples in XML Documentation

Is there a way to include examples for multiple languages (C# and Visual Basic, for example) in XML documentation? I'm using SandCastle to build MSDN-style documentation and would like to include usage examples for a few .NET languages. ...

error during build using sandcastle help builder with visual studio 2010 .NET 4.0 project

I was using sandcastle to generate help for my project in visual studio 2008. When i change my project to visual studio 2010 and change the project .NET version to .NET 4.0 i got this problem with Sandcastel. I can't understand why sandcastel is using C:\Windows\Microsoft.NET\Framework64\v3.5\MSBuild.exe and not C:\Windows\Microsoft.NET...

Sandcastle Help Builder - SandcastleBuilder.Components.ShowMissingComponent' was not found

NOTE: Posted on Sandcastle Help Builder website as well. I got this error: BUILDASSEMBLER : error : BuildAssembler: The type 'SandcastleBuilder.Components.ShowMissingComponent' was not found in the component assembly 'C:\Program Files\EWSoftware\Sandcastle Help File Builder I checked (vis Reflector); it's there. Uninst...

Is it possible to use SandCastle with Visual Studio 2008 and C++ (non-CLI)?

Hi, I'm mystified: I'm using Visual Studio 2008 with C++ (non-CLI), and I can't for the life of me work out how to build the help file with Sandcastle. Once its installed, and its generating an .xml file, shouldn't there be a menu option somewhere to switch on the build of the docs? Or at least a menu option to trigger the build of the...

is there a sandcastle plugin for Visual Studio 2010?

I really like the help files generated using SandCastle on my projects... is there a plugin for Visual Studio 2010 for SandCastle, or another good alternative program that integrates directly with Visual Studio? ...

How does Sandcastle Conceptual Help compare to Doxygen Pages?

Sandcastle has a fairly complex XML MAML for generating Conceptual Help, as discussed in a nice intro from 2007. How does this compare to Doxygen in terms of ease of writing content and control over generation of the pages? I am a big fan of using the Doxygen page facility to write such conceptual help including discussions of design is...

Missing comments on enumeration members in sandcastle docs

I have noticed that my sandcastle documentation is missing any comment that was placed on enumeration member however the XML documents document produced by visual studio does contain the missing data. ...

How should I document a inherited members?

Consider that I have a complex class structure where many elements inherit from other elements. I may have a method GetStuff(string stuffName, int count) defined in an interface, which is inherited by other interface, which is then implemented abstractly by an abstract class, which is then implement explicit in a concrete class etc. etc....

Does Sandcastle support code contracts?

My library uses code contracts. Is there a way to incorporate these contracts in the documentation generated by sandcastle? ...

How do I add a code snippet to a sandcastle project?

I added a code snippet to a sandcastle project. However, the code snippet does not show up in the resulting help file? How do I specify that I want to add it? ...

How to build HTML Documentation with Sandcastle

How to build CHM / HTML Documentation with Sandcastle? Can build HTML file from XML or have to used .cs and dll files? ...

Generate pure HTML documentation with Sandcastle (no ASP.NET)

I am using Sandcastle with the Sandcastle Help File Builder on a very large project. This works really fine, but I wanted to upload the generated documentation to my project page, and the documentation generated by Sandcastle contains ASP.NET code while I only own a Linux-based webserver. Is it possible to generate pure HTML documentati...

Is there an XML tag in the C# comment syntax that allows for a section of text to be ignored by comment generators?

Does anyone know if there is an XML comment tag that allows one to hide text from a comment generator (specifically sandcastle)? For example, given the following: /// <summary> /// Returns the sum of two numbers. /// </summary> /// <hide>I do not want this text in any documentation generated by sandcastle.</hide> /// <param name="a">T...

Sandcastle Help File Builder - how to change msbuild path?

I'm trying out Sandcastle Help File Builder. If I run the build from the gui I'm getting this error: C:\Program Files\MSBuild\Microsoft\VisualStudio\v9.0\WebApplications\Microsoft.WebApplication.targets" was not found This is because it's in C:\Program Files (x86) directory. So how do I configure to use that dir instead? ...

Is there way to get intellisense when editing AML files in SandCastle?

I am using sandcastle to auther my help files. Editing AML files is painful because there as no intellisense support - unlike, say, ASP.NET or XAML in Visual Studio. Is there a better way? ...

Embedding a region of code in a help file.

I am using sandcastle to build my help file. Is there a way to add code samples from actual C# files? Ideally, I would have C# files with region, reference the region from sandcastle. Sandcastle would then embed the content of the region when building. Is this feasible? ...

How can i show method body to A Sandcastle Documented Class Library

Hi there I've made class diagrams for my projects in Visual Studio 2008 and I embed these diagrams with using Sandcastle. Example: *A Sandcastle Documented Class Library Biol..::..f_BiolabTestSayisi Method Biol Class See Also Send Feedback Biol hastalarının sayısını veren fonksiyon Namespace: TR.Biol Assembly: TR (in TR.dll) Versi...