On 7/18/12 12:59 PM, Ben Webb wrote: > On 07/18/2012 12:55 PM, Javier Velazquez-Muriel wrote: >> I suggest a beautiful method to do this. Use WARN_IF_UNDOCUMENTED from >> doxygen, and a simple rule: Warning, then failed commit. > > Well, that isn't that difficult to implement... but it doesn't force > people to write useful documentation (it just forces people to make > the check happy by adding /** xxx */ to every function). > > Ben
Well, this is documentation indeed. It should be read as: "I didn't bother". I'm not saying that all functions, even the trivial ones should be documented. As usual, common sense applies . A function add_one_to_number(number) does not need documentation. Well, then document /** obvious */. It is no asking for too much.