Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

[Lluís Vilanova]

Richard Henderson writes:

> On 01/14/2015 10:15 AM, Lluís Vilanova wrote:
>> Sorry I wasn't clear. I meant that it might be better to remove tcg/README 
>> and
>> instead document all the operations (those in the readme and the additional
>> ones) in the header.

> If we did that, it would go somewhere else.

Yes, I meant moving it to the header.


> There are two different (but clearly closely related) things that
> need documenting:

>   (1) The functional interface used by target-*/translate.c.
>       This is what Bastian is attempting to document now.

>   (2) The intermediate language opcodes.
>       This is what is currently documented in tcg/README.

Ok, it just seemed to me that documenting the interface would add some
duplication between both, making it less likely to keep all docs in sync when
opcodes change. Maybe it's just me being paranoid, since opcodes rarely change.


Thanks,
  Lluis

-- 
 "And it's much the same thing with knowledge, for whenever you learn
 something new, the whole world becomes that much richer."
 -- The Princess of Pure Reason, as told by Norton Juster in The Phantom
 Tollbooth