On Tue, Aug 06, 2013 at 02:16:02PM +0100, Alex Bligh wrote:
> --On 6 August 2013 14:26:33 +0200 Stefan Hajnoczi
> <stefa...@redhat.com> wrote:
> 
> >Please use doc comments (see include/object/qom.h for example doc
> >comment syntax).
> 
> Should these go in the .h (per include/qom/object.h) or the .c (per
> your comment)?

I don't think there is a strict rule.

I like putting doc comments in the .c file for non-external APIs.  That
way it's easier to remember that the doc comment needs to be updated if
the function is modified.

Stefan

Reply via email to