Ref. overloaded method in XML comments -- dotnet framework

Paul S
10/31/2007 2:16:00 AM

Hi Walter

Your answer made me try - again - to do what you suggested without luck. I
think the problem is the the Update method is an abstract method in a base
class - sorry that wasn't in the original question

--
Regards
Paul S

[quoted text, click to view]

wawang NO[at]SPAM online.microsoft.com (
10/31/2007 9:55:24 AM

Hi Paul,

I just tried following code:

/// <summary>
/// <see cref="Foo.Bar()" />
/// <see cref="Foo.Bar(int)" />
/// </summary>
public abstract class Foo
{
/// <summary>
/// </summary>
public abstract void Bar();
/// <summary>
/// </summary>
public abstract void Bar(int x);
}

/// <summary>
/// <see cref="Child.Bar()" />
/// <see cref="Child.Bar(int)" />
/// </summary>
public class Child : Foo
{
/// <summary>
/// </summary>
public override void Bar()
{
}

/// <summary>
/// </summary>
public override void Bar(int x)
{
}
}

csc /target:library /doc:foo.xml foo.cs

and it didn't generate any warnings or errors.

Would you please create a reproducible project and send it to me? Thanks.

Regards,
Walter Wang (wawang@online.microsoft.com, remove 'online.')
Microsoft Online Community Support

==================================================
When responding to posts, please "Reply to Group" via your newsreader so
that others may learn and benefit from your issue.
==================================================

This posting is provided "AS IS" with no warranties, and confers no rights.

wawang NO[at]SPAM online.microsoft.com (
10/31/2007 9:56:55 AM

By the way, I'm using Visual Studio 2005.

Paul S
11/5/2007 3:48:03 AM

Hi Walter
My project is in VB but I don't see that that should make a difference. I
think I need to boil my project down to a small example.
--
Paul S

[quoted text, click to view]

Paul S
11/7/2007 1:10:02 AM

That solved the problem - thanks a lot Walter
--
Regards
Paul S

[quoted text, click to view]

wawang@online.microsoft.com (
11/7/2007 6:05:37 AM

Hi Paul,

This looks like an issue of VB.NET compiler that currently didn't expand
the method in "cref" attribute:

#VB.NET 2005 / Sandcastle treatment of <see cref=""/> - MSDN Forums
http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=802863&SiteID=1

#Feedback: VB 2005 (SP1 Beta 1) code comments: Link tag attribute not
converted from relative to full path by compiler.
http://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?Feedbac
kID=219950

If you manually specify a full expanded method reference, then VB.NET will
not issue the warning:

''' <summary>
''' <see cref="Foo.Bar" />
''' <see cref="M:Foo.Bar(System.Int32)" />
''' </summary>
Public MustInherit Class Foo
Public MustOverride Sub Bar()
Public MustOverride Sub Bar(ByVal x As Integer)
End Class

We're sorry for the inconvenience.

Regards,
Walter Wang (wawang@online.microsoft.com, remove 'online.')
Microsoft Online Community Support

==================================================
When responding to posts, please "Reply to Group" via your newsreader so
that others may learn and benefit from your issue.
==================================================

This posting is provided "AS IS" with no warranties, and confers no rights.

Got something to say? Click here to post a reply to this thread.

Don't see what you're looking for? Try a search.

View other messages about dotnet framework

dotnet framework : Ref. overloaded method in XML comments