[Doxygen-users] Documenting abstract base classes

[Evil K. <evi...@ya...>]

Hi guys, busy tonight huh =]

okay, I was wondering, if I have an abstract base class and a derived type, 
the methods in the base class and derived class do the same job, but where 
to put the documentation saying what the method does.  What I mean, is 
you've got the abstract base class, do you put the documentation saying 
what each method does in there with the class, or do you leave all the 
documentation for each implementation you do of that base class?  Since if 
you have a base class and derived class, if you document both, you'll be 
repeating documentation wont you, for each class, so it seems kinda 
silly.  Especially when you read the documentation back to yourself, you 
read the definition, it says "Opens a File", then nothing else, then you 
read the implemenation, it says "Opens a File" and then goes on to say what 
the actions of the method are, what it does, etc etc.

Does anyone know what I mean? if they do, what do you do in this situation? 
do you only document the abstract base class or the derived, or do you 
document both?

thanks again!

kosh 


_________________________________________________________
Do You Yahoo!?
Get your free @yahoo.com address at http://mail.yahoo.com