473,378 Members | 1,512 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

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

Referencing specific method overloads in a <see> tag

I am using the XML documentation feature of VS.NET. Several of my classes
have overloaded methods. I would like to create a <see> tag that refers to
a specific overload (as opposed to the general overview of them all). How
can I do this?

For example, imagine that there are two overloads of the method Foo on the
class Bar:
Bar.Foo()
Bar.Foo(String myString)

I would like to create tags like this:
<see cref="Bar.Foo()">Foo version 1</see>
<see cref="Bar.Foo(myString)">Foo version 2</see>

Right now all I know how to do is this:
<see cref="Bar.Foo">Foo</see>
But this is not specific enough.

Regards,
- Alex VanderWoude
Nov 12 '05 #1
2 3904
You can try something like <see cref="Bar.Foo(String)>...</see>.

What goes in the parenthesis is the type of what is being passed in, not the
parameter name.

"Alex VanderWoude" <al**@computronix.com> wrote in message
news:Xn********************************@64.187.24. 4...
I am using the XML documentation feature of VS.NET. Several of my classes
have overloaded methods. I would like to create a <see> tag that refers to a specific overload (as opposed to the general overview of them all). How
can I do this?

For example, imagine that there are two overloads of the method Foo on the
class Bar:
Bar.Foo()
Bar.Foo(String myString)

I would like to create tags like this:
<see cref="Bar.Foo()">Foo version 1</see>
<see cref="Bar.Foo(myString)">Foo version 2</see>

Right now all I know how to do is this:
<see cref="Bar.Foo">Foo</see>
But this is not specific enough.

Regards,
- Alex VanderWoude

Nov 12 '05 #2
You can try something like <see cref="Bar.Foo(String)>...</see>.

What goes in the parenthesis is the type of what is being passed in, not the
parameter name.

"Alex VanderWoude" <al**@computronix.com> wrote in message
news:Xn********************************@64.187.24. 4...
I am using the XML documentation feature of VS.NET. Several of my classes
have overloaded methods. I would like to create a <see> tag that refers to a specific overload (as opposed to the general overview of them all). How
can I do this?

For example, imagine that there are two overloads of the method Foo on the
class Bar:
Bar.Foo()
Bar.Foo(String myString)

I would like to create tags like this:
<see cref="Bar.Foo()">Foo version 1</see>
<see cref="Bar.Foo(myString)">Foo version 2</see>

Right now all I know how to do is this:
<see cref="Bar.Foo">Foo</see>
But this is not specific enough.

Regards,
- Alex VanderWoude

Nov 12 '05 #3

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

11
by: Les Paul | last post by:
I'm trying to design an HTML page that can edit itself. In essence, it's just like a Wiki page, but my own very simple version. It's a page full of plain old HTML content, and then at the bottom,...
0
by: Kent Boogaart | last post by:
Hello, It appears that the <see> element has a breaking change in 2.0. In 1.1 it would automatically resolve overloads so you could just write <see cref="string.Format"/> and it would link to...
3
by: Dario | last post by:
What I have to write in the <see> tag in order to access the constructor of a class? E.g.: to access the constructor of a class MyClass I try <see cref="MyClass.MyClass"/> but it does not work....
2
by: Tom Vogel | last post by:
I'd like to use the XML Documentation Tags to comment my C# code. But many of the tags do not have any effect when I execute the "Build Comment Web Pages" menu. For example, the <list> tag gets...
1
by: Bob Rundle | last post by:
The following construct generates a good XML file, but "Build Comment Web Pages..." does not do anything sensible with the <see> tag. Is there a bug in this tool? Bob Rundle using System;...
1
by: Lasse Vågsæther Karlsen | last post by:
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) {
0
by: Clive Dixon | last post by:
Is there any way of resolving out of scope references in doc tags? I was hoping that the compiler might leave unresolved (but fully qualified by namespace) references intact so that NDoc could...
1
by: dani | last post by:
Hi Everyone, I wanted to create a large text box (a textarea) for displaying some large information for editing. I am using a DetailsView control with an SQL data source, but every time I try to...
6
by: edd | last post by:
Hello all, Is there a way to determine whether a particular type supports the -> operator at compile time? I'm trying to write a template function (or a series of overloads) that will yield the...
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...
0
by: ryjfgjl | last post by:
In our work, we often need to import Excel data into databases (such as MySQL, SQL Server, Oracle) for data analysis and processing. Usually, we use database tools like Navicat or the Excel import...
0
by: taylorcarr | last post by:
A Canon printer is a smart device known for being advanced, efficient, and reliable. It is designed for home, office, and hybrid workspace use and can also be used for a variety of purposes. However,...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: aa123db | last post by:
Variable and constants Use var or let for variables and const fror constants. Var foo ='bar'; Let foo ='bar';const baz ='bar'; Functions function $name$ ($parameters$) { } ...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...

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.