Menu

#205 <see><seealso> tags always reference 1st method overload

closed
None
5
2014-08-20
2004-11-29
No

Hello,

I have a problem with references in the <see> and
<seealso> tags:

When referencing an overloaded method from any of
both tags, I have the link in the final documentation
always pointing to the first overload version of the
method.

I have reviewed the .XML generated by Visual Studio
2003 and it seems IT (VS2003) is the one adding the
argument information for the 1st overload.

E.g.:

<see
cref="M:DanielRG.SimplIRC.IRCSession.SendCommand
(DanielRG.SimplIRC.IRCCommands,System.String
[])"/>

I would like to have the reference pointing to the
method's GENERAL OVERLOADS page. Tried removing
argument info from the .XML file manually:

<see
cref="M:DanielRG.SimplIRC.IRCSession.SendCommand"
/>

but then NDoc seems to ignore the tag (puts it in bold).

I have installed last release of NDoc (NDoc-v1.3-
rc1a.msi).

Any way to achieve what I want?

Thank you.

Discussion

  • Kevin Downs

    Kevin Downs - 2004-12-01
    • assigned_to: nobody --> kdowns
    • status: open --> closed
     
  • Kevin Downs

    Kevin Downs - 2004-12-01

    Logged In: YES
    user_id=919791

    As you have discovered, there is no way to reference
    the 'overloads' page.

    This is a 'feature' of xml comments; When they designed the
    original spec, they didn't think through the requirements very
    well :-(

    Unfortunately, the compiler checks 'cref' attributes to ensure
    they are on-spec. this means that we cannot define our own
    format for this; The spec needs an ehancement, and then MS
    would have to implement it. This will be a *very* slow
    process!

    Once NDoc 1.3 has been relased, I will revisit the problem and
    see if there is a work-around which we could introduce in the
    next release...

     
  • Daniel R. G.

    Daniel R. G. - 2004-12-01

    Logged In: YES
    user_id=1095207

    Ok, I see.

    Thank you very much for your support.

     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.