Hello!
My question is difficult to explain so I will give an example.

ListClass::NextPos()
{
//Moves to the next element in the list
}

When I access the method in the client code,

List.NextPos() I want it to show the documentation when I highlight over one of the methods I can choose from. Usually, It shows documentation but its never matches up. My question is, where do I put the documentation in my classes so the documentation shows up in the little pop up menu. Also, is there a way i could just highlight the documentation and the code and bind them together?

Thanks!

This post has been edited by Umbrella: 14 Mar, 2007 - 03:22 PM

This depends upon your IDE. To my knowledge, most ide's don't use comments to generate those neat little popups which tell you the declaration information. The information for those comes directly from the declarations at the begining of your file (or from an included header file). If you want to make those popups more helpful then use more discriptive variable names, apart from that I don't know.

Some IDEs do have an "object browser" function which allows your to look at classes and generally there is a little "discription" of each member. I don't have any clue as to how that information gets there. (I know in VB6 you can add these comments but I am not aware of where they might come from or go to in a C/C++ file, though I assume there must be a way.) I don't belive that these little discriptions ever come up as popups in an ide.

There are other source control programs which mimic javadocs and allow you to insert comments which are extracted to create a documentation "man-page" from your code. These are very nice if you have the time and patiencs to add these enlightening comments. It is nice to generate both the library and the documentation all with the click of one button. But to my knowledge this information does not help produce popups in the ide.

Basicly I think you just have to work with your declarations.

Thanks for your time and help!