CAJ

Hi there

I'm new to Sandcastle and the Sandcastle Help File Builder. I'm using the March CTP release of Sandcastle. I've got the following XML comments in my code:

''' <seealso cref="xxx.Business.AgentSearchResult">See agent search result</seealso>

I'm builidng this in the Sandcastle Help File Builder in HTMLHelp1x format with ProjectLinkType=local. I get the "See Also" section showing and the text in the tag shown in bold, but it's not linking to the local resource. the local resource exists in the documentation file (it's a class) The namespace xxx is the DLL being documented.

Is there something I need to set to get these links working Everything else seems to work as expected.

Cheers

Craig



Re: Developer Documentation and Help System Newbie: SeeAlso tags only showing as bold text instead of links

EWoodruff

The VB.NET compiler doesn't always generate a full reference for the cref attribute. Check the XML comments file produced by the compiler. You'll probably find that the cref is just "AgentSearchResult". I don't think there's a fix for it. Adding the prefix such as "T:" for type or "M:" for method etc plus the fully qualified name might be the workaround but I don't recall. This has come up before so you might search the forum for other related posts.

Eric





Re: Developer Documentation and Help System Newbie: SeeAlso tags only showing as bold text instead of links

CAJ

Putting T: in the CREF tag did the trick. Thanks