Documenting overloaded functions

[Rowena Hart <rowena_hart -at- yahoo -dot- com>]

Hi all,

I'm trying to document a few classes for some
object-oriented code. I've run into a real
head-scratcher: how do I document overloaded
functions?

I've looked at some documentation for .NET classes and
it seems like they document the overloaded functions
separately based on data type, i.e. Func(object),
Func(char), Func(int).

Is this the "standard" way to document overloaded
functions? It seems very repetitive/verbose to me. Is
there a simpler way to document overloaded functions
that would still allow programmers to quickly access
the info they need?

Word of warning: I'm not a programmer, but I have
enough programming knowledge to be dangerous to myself
and to others. Very specific answers with examples
would be appreciated.

Thanks,

Rowena

__________________________________________________
Do you Yahoo!?
The New Yahoo! Search - Faster. Easier. Bingo
http://search.yahoo.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Last chance to order RoboHelp X3 and receive a $100 mail-in rebate, 
PLUS free RoboScreenCapture and WebHelp Merge Module. Offer expires 
4/30/03! Order here: http://www.ehelp.com/techwr-l

   Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot-  Visit
http://www.raycomm.com/techwhirl/ for more resources and info.