Overloads

Jul 9, 2007 at 11:37 AM
Edited Jul 9, 2007 at 11:38 AM
Hi

How can i document overloads of a method with a specific documentation?
Coordinator
Jul 9, 2007 at 7:49 PM
I'm not sure what you're asking. Can you give an example?

Eric
Jul 10, 2007 at 5:09 AM
Hi Eric

Thanks for you quick reply. My question is a beginner's question.
I have a method with a few overloads. The generated help file has an overload page, that describes all the overloads as one, and then specifies each overload and it's uses.
How can I customize the overloads page for each method?

Regards
Noam
Coordinator
Jul 10, 2007 at 3:23 PM
If you want to customize the text at the top of the overloads page, put an <overloads> tag on one of the methods (i.e. <overloads>There are six overloads for this method</overloads>). As for the other text that describes the methods on the overloads page, it's pulled from the <summary> tag so as long as you have a summar description on each one, it will appear on the overloads page.

Eric
Jul 19, 2007 at 10:34 AM
Tnx