--On 7 August 2013 13:31:07 +0200 Stefan Hajnoczi <stefa...@gmail.com> wrote:
Regarding doc comments: if the function is self-documenting then the doc comment might not add much. I think in those cases it's okay to omit details about arguments or return values if they are clear from the function prototype.
Given I've done them for every function, I hope they don't cause any active harm. I was concerned that with an API change some things that one might have thought were obvious are in fact not obvious (e.g. timer_del vs. timer_free). -- Alex Bligh