473,324 Members | 2,257 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,324 software developers and data experts.

Generating the tooltip documentation?

Alright, so I've got a class library that others will be using. When you hover the mouse over most of the exiting .NET
classes/methods, you will get a tooltip popup showing the full name/declaration of the class or method, along with a line of text
description.

I am attempting to add similar descriptions to the methods and classes in my library. I've entered descriptions into the <summary>
tags that get added by default, but none of it seems to show up when I actually add my library as a reference in another project.
Is there some trick to it? Or something else I have to do altogether?

Thanks

--
Adam Clauss
ca*****@tamu.edu
Nov 16 '05 #1
1 1337
Adam Clauss wrote:
Alright, so I've got a class library that others will be using. When you hover the mouse over most of the exiting .NET
classes/methods, you will get a tooltip popup showing the full name/declaration of the class or method, along with a line of text
description.

I am attempting to add similar descriptions to the methods and classes in my library. I've entered descriptions into the <summary>
tags that get added by default, but none of it seems to show up when I actually add my library as a reference in another project.
Is there some trick to it? Or something else I have to do altogether?


You need to generate an XML doc file ("XML Documentation File" property
in a VS.NET project, or the /doc option in a command-line build).

Make sure this xml file is in the same directory, with the same base
name as the assembly that is being referenced.

--
mikeb
Nov 16 '05 #2

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

Similar topics

2
by: drb | last post by:
I have a MAP object on an aspx page. The MAP object contains a number of AREA objects. I would like to assign a tooltip or onmouseover event to each of these AREA objects, but it doesn't look like...
0
by: Yves Royer | last post by:
Hi, I'm currently writing an application (in VS 2005 bèta 2) and made some own user controls. In each user control I added a ToolTip object so i can set some tooltips on checkboxes etc. What...
0
by: Yves Royer | last post by:
Hi, My first post didn't show up so here's a second try. I'm currently writing an application (in VS 2005 bèta 2) and made some own user controls. In each user control I added a ToolTip object...
14
by: Scott M. | last post by:
How do I add information to a custom class's properties and methods so that when an instance of the class is made the VS.NET intelliSense will show the information in a tooltip as the members are...
3
by: S?ren Olesen | last post by:
Hi If you in Visual Studio (VB) write String.E then you'll get a list of possible methods and for each method I get a small ToolTip describing the method.... How do I add information to my...
1
by: Ryan Ginstrom | last post by:
I have been maintaining a body of documentation in plain HTML files. I would now like to automate the generation of the HTML files. Maintaining the HTML files now is tedious and error prone,...
5
by: =?Utf-8?B?cGV0ZTE5Njk=?= | last post by:
I use Visual Studio 2005 and created a very simple Form with one button. I added a Tooltip for that button. It shows fine the first time I hover over that button. But if I let it disappear by the...
6
by: john | last post by:
I have the following textbox setup with Text & ToolTip Bindings as follows; I'm using Visual Studio 2008 VB: <asp:TextBox ID="txtDay1" runat="server" Text='<%# Eval("Day1") %>'...
16
by: Charles Law | last post by:
I have to take this personally now. Tooltips have been flakey since the dawn of .NET, but to still have to put up with a disappearing tooltip in VS 2008 is getting beyond a joke. Tooltips have...
0
by: DolphinDB | last post by:
Tired of spending countless mintues downsampling your data? Look no further! In this article, you’ll learn how to efficiently downsample 6.48 billion high-frequency records to 61 million...
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
1
by: PapaRatzi | last post by:
Hello, I am teaching myself MS Access forms design and Visual Basic. I've created a table to capture a list of Top 30 singles and forms to capture new entries. The final step is a form (unbound)...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
1
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
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...

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.