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

Posted by brickner on Stack Overflow See other posts from Stack Overflow or by brickner
Published on 2010-05-01T14:38:32Z Indexed on 2010/05/01 14:47 UTC
Read the original article Hit count: 407

Filed under:

sandcastle

|

xml-documentation

|

enums

|

c#

|

MSDN

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 documentation file, but the link leads me to an MSDN Page not found

I don't get any warnings - my xml documentation is correct.

I've noticed that MSDN pages that refer to an enum value also have a Page not found link. For example: UInt64.Parse Method (String, NumberStyles, IFormatProvider) refers to NumberStyles.AllowHexSpecifier and this leads to another MSDN Page not found.

Should I refer to the enum instead of the enum value?

What should I do to refer an enum? Is it even possible?

© Stack Overflow or respective owner

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

Related posts about xml-documentation

Enabling XML-documentation for code contracts

as seen on ASP.net Weblogs - Search for 'ASP.net Weblogs'
One nice feature that code contracts offer is updating of code documentation. If you are using source code documenting features of Visual Studio then code contracts may automate some tasks you otherwise have to implement manually. In this posting I will show you some XML documentation files with documented… >>> More
StyleCop XML Documentation Header - Using 3 /// instead of 2 //

as seen on Stack Overflow - Search for 'Stack Overflow'
I am using XML documentation headers on my c# files to pass the StyleCop rule SA1633. Currently, I have to use the 2 slash commenting rule to allow StyleCop to recognize the header. for example: // <copyright file="abc.ascx.cs" company="MyCompany.com"> // MyCompany.com. All rights reserved… >>> More
XML documentation to context sensitive help

as seen on Stack Overflow - Search for 'Stack Overflow'
These days a number of commercial and open source tools have been developed for this purpose. However(unfortunately), non of them meet my requirement for specific problem I am dealing with. Currently, I am working on a project that exposes a different classes and functions to user as scripting interface… >>> 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
Share xml-documentation accross overloads

as seen on Stack Overflow - Search for 'Stack Overflow'
Hey, is there a way to share xml-documentation of the parameters to all the overloads? Lets say I have 10 overloads of a method but they all share the first 5 parameter (I use C# so I cannot have optional parameters). How do I do so that I do not have to write the same text for all of the parameters… >>> More