Vincent van Ravesteijn wrote:
> It's not necessary to comment these functions. 

Note that I just fixed some typos. OK, I've also transformed some normal 
comments to doxygen comments. But then, these ones were rather arbitarily not 
doxgen comments, while most others were.

> It might even be better 
> not to. If one decides to improve the documentation, one doesn't want to 
> search the whole project for places where this function is overriden 
> just to adapt the documentation. Also, this may lead to different 
> documentation at different locations. Last, there is no way to see that 
> this function is defined in Inset.h.

All right, but for sure we want to have some documentation in the header 
files. I don't want to open Inset.h or fire up the doxygen-generated 
documentation when working on some specific inset.

So if we do not want doxygen comments for inherited functions, we should at 
least use normal comments.

Jürgen

Reply via email to