This project is read-only.
7
Vote

Cannot link to Overload page

description

Sandcastle does not correctly generate links to the overload page for a group of overloaded methods when a <see cref="..."/> link is specified without method arguments. Instead, the link incorrectly goes to the first method in the overload group.
 
Example: You have two methods, Foo(Int32) and Foo(Int32, Int32). The overload page for these methods is created and linked into the TOC correctly. However, when you attempt to create a comment link to that overload page, using <see cref="Foo"/>, that link will point to Foo(Int32) in the compiled documentation.
 
This bug appears in the current May 2008 release of Sandcastle (version 2.4.10520). I tested both the Prototype and the VS2005 style.

comments

EWoodruff wrote May 25, 2009 at 7:41 PM

This has been mentioned before. See this MSDN Documentation Forum thread for a possible workaround: http://social.msdn.microsoft.com/Forums/zh-CN/devdocs/thread/3906970c-4825-492b-8536-8bf644b46648

cnahr wrote May 27, 2009 at 6:48 AM

Thanks for the pointer. The workaround is certainly ingenuous but very cumbersome, and apparently no longer works in post-2006 versions of Sandcastle.

I'm opening a new MSDN thread on this subject since the linked one is marked as answered, and new posts to "answered" threads tend to get ignored (witness the last two posts asking for status updates that went unanswered since 2007).

wrote Jan 13, 2010 at 10:14 PM

wrote Jan 19, 2010 at 5:31 PM

cnahr wrote Jul 8, 2010 at 8:05 AM

Bumping this issue -- the bug still persists in the current Sandcastle release, and my new MSDN thread went unanswered so far.

wrote Sep 13, 2010 at 12:59 PM

CharlieR wrote Sep 13, 2010 at 1:20 PM

This issue existed since the beginning of Sandcastle and has never been fixed. There have been workarounds but these seem to be no longer working.

It should be possible to add a <see cref="O:myNamespace.myOverloadedMethod"/> or <seealso cref="O:myNamespace.myOverloadedMethod"/> tag to link to the overload page for the methods. A single letter with colon is the only way the C# compiler accepts.

See also the first post of Bucket to the following thread: [url:http://social.msdn.microsoft.com/Forums/en-US/devdocs/thread/3906970c-4825-492b-8536-8bf644b46648]

cnahr wrote Sep 14, 2010 at 6:56 AM

Yes, I was aware of this thread (and referenced it in my own -- unanswered -- thread) but as you say, the posted workarounds apparently no longer works, and in any case was quite cumbersome. This really needs to get fixed in Sandcastle itself.

wrote Apr 26, 2011 at 1:26 AM

wrote Jan 28, 2012 at 2:43 PM

wrote Jan 26, 2013 at 1:12 PM

wrote Jan 26, 2013 at 1:12 PM

wrote Jan 26, 2013 at 1:13 PM

wrote Jan 26, 2013 at 1:13 PM

wrote Feb 22, 2013 at 1:40 AM