471,627 Members | 2,356 Online
Bytes | Software Development & Data Engineering Community
Post +

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 471,627 software developers and data experts.

XML Documentation in .NET 2.0 and <see...> links to overloaded methods

If I got the following three methods:

/// <summary>
/// Tests the string.
/// </summary>
/// <param name="s">
/// The string to test.
/// </param>
public void Test(String s)
{
}

/// <summary>
/// Tests the integer.
/// </summary>
/// <param name="i">
/// The integer to test.
/// </param>
public void Test(Int32 i)
{
}

/// <summary>
/// Performs a simple test.
/// </summary>
/// <remarks>
/// Also, see <see cref="Test"/> for more information. ----------- here!
/// </remarks>
public void Test2()
{
}

and then compiles this I get:

D:\Dev\VS.NET\DocumentationTest1\DocumentationTest 1\GenericClass1.cs(59,34):
warning CS0419: Ambiguous reference in cref attribute: 'Test'. Assuming
'DocumentationTest1.GenericClass1.Test(string)', but could have also
matched other overloads including
'DocumentationTest1.GenericClass1.Test(int)'.

Is there a way to make a link that refers to the overloaded method list?
Using NDoc I can easily output such a page that contains links to the
specific versionf of the overload method.

--
Lasse Vågsæther Karlsen
http://usinglvkblog.blogspot.com/
mailto:la***@vkarlsen.no
PGP KeyID: 0x2A42A1C2
Dec 1 '05 #1
1 2223
On Thu, 01 Dec 2005 23:42:16 +0100, Lasse Vågsæther Karlsen
<la***@vkarlsen.no> wrote:
Is there a way to make a link that refers to the overloaded method list?


You already found it. The link works fine, it's just that the
compiler warning is stupid. Add compiler warning 0419 to your list of
ignored warnings (in the project settings).
--
http://www.kynosarges.de
Dec 2 '05 #2

This discussion thread is closed

Replies have been disabled for this discussion.

Similar topics

2 posts views Thread by Donald Firesmith | last post: by
4 posts views Thread by Guillaume CABANAC | last post: by
5 posts views Thread by Suman | last post: by
3 posts views Thread by ajay2552 | last post: by
8 posts views Thread by Peter Larsen [CPH] | last post: by
reply views Thread by leo001 | last post: by

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.