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 have a different opinion.

I don't want to open Inset.h or fire up the doxygen-generated
documentation when working on some specific inset.

That's the price to pay for having good comments in one place and avoiding a lot of different/outdated/wrong/incomplete comments scattered all over the code. The same principle as that we aim to prevent duplicated code as much as possible.

Usually the IDE has a pretty easy way of navigating to the declaration of a function.

Vincent

Reply via email to