DocProject vs Sandcastle Help File Builder GUI

Posted by Nathan on Stack Overflow See other posts from Stack Overflow or by Nathan
Published on 2008-11-26T03:00:02Z Indexed on 2010/12/22 9:54 UTC
Read the original article Hit count: 302

Filed under:

c#

|

sandcastle

I have several C# projects along with some internal library components that I'm trying to document together. Sandcastle seems to be the place to go to generate documentation from C#. I would like to know which of the two, DocProject or Sandcastle Help File Builder GUI is better and supports the features I need.

I would like to compile only each projects own part of the document and then have it all integrated together in the end. (i.e. the library components in one documentation project and each project in it's own documentation project, then all of the above in a single root using the Help 2 viewer)

© Stack Overflow or respective owner

Related posts about c#

.NET WebRequest.PreAuthenticate not quite what it sounds like

as seen on West-Wind - Search for 'West-Wind'
I’ve run into the problem a few times now: How to pre-authenticate .NET WebRequest calls doing an HTTP call to the server – essentially send authentication credentials on the very first request instead of waiting for a server challenge first? At first glance this sound like it should be easy:… >>> More
HttpWebRequest and Ignoring SSL Certificate Errors

as seen on West-Wind - Search for 'West-Wind'
Man I can't believe this. I'm still mucking around with OFX servers and it drives me absolutely crazy how some these servers are just so unbelievably misconfigured. I've recently hit three different 3 major brokerages which fail HTTP validation with bad or corrupt certificates at least according to… >>> More
The dynamic Type in C# Simplifies COM Member Access from Visual FoxPro

as seen on West-Wind - Search for 'West-Wind'
I’ve written quite a bit about Visual FoxPro interoperating with .NET in the past both for ASP.NET interacting with Visual FoxPro COM objects as well as Visual FoxPro calling into .NET code via COM Interop. COM Interop with Visual FoxPro has a number of problems but one of them at least got a lot… >>> More
Dynamic Type to do away with Reflection

as seen on West-Wind - Search for 'West-Wind'
The dynamic type in C# 4.0 is a welcome addition to the language. One thing I’ve been doing a lot with it is to remove explicit Reflection code that’s often necessary when you ‘dynamically’ need to walk and object hierarchy. In the past I’ve had a number of ReflectionUtils that used string based expressions… >>> More
Finding a Relative Path in .NET

as seen on West-Wind - Search for 'West-Wind'
Here’s a nice and simple path utility that I’ve needed in a number of applications: I need to find a relative path based on a base path. So if I’m working in a folder called c:\temp\templates\ and I want to find a relative path for c:\temp\templates\subdir\test.txt I want to receive back subdir\test… >>> More

Related posts about sandcastle

Using Sandcastle to build code contracts documentation

as seen on ASP.net Weblogs - Search for 'ASP.net Weblogs'
In my last posting about code contracts I showed how code contracts are documented in XML-documents. In this posting I will show you how to get code contracts documented with Sandcastle and Sandcastle Help File Builder. Before we start, let’s download Sandcastle tools we need: Sandcastle … >>> More
Does Sandcastle support Entity Framework Partial Classes?

as seen on Stack Overflow - Search for 'Stack Overflow'
I am attempting to use Sandcastle (and Sandcastle Help File Builder) to do some "auto-documentation" of some classes I am using. The classes that are giving me trouble are some partial classes on Entity Framework items that add methods and properties to those Framework items. The triple slash comments… >>> More
How to exclude non-browsable members in a sandcastle xml documentation build

as seen on Stack Overflow - Search for 'Stack Overflow'
I'd like to be able to exclude members that, although Public, are decorated with EditorBrowable.Never. I can't see any where to do it in the options. Is there a plug-in out there where you can specify attributes to exclude? Cheers >>> More
Documenting using Sandcastle: Refering to enum value using <see>

as seen on Stack Overflow - Search for 'Stack Overflow'
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… >>> More
Is SandCastle a dead project ?

as seen on Stack Overflow - Search for 'Stack Overflow'
Microsoft killed NDoc when they released a CTP/Beta version of Sandcastle. And I rarely see information about new version of a usable version of sandcastle (with an integrated UI for example). The latest realease is the May 2008 release. Is Sandcastle a dead project or will it be included with Visual… >>> More