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

[Lluís Vilanova]

Bastian Koppelmann writes:

> On 01/14/2015 03:36 PM, Lluís Vilanova wrote:
>> Bastian Koppelmann writes:
>> 
>>> There is no overview, that shows all the frontend operation one can use, as
>>> found on the wiki. Unfortunatly the wiki is out of date, so let's try to 
>>> move
>>> this documentation to the source files, which has the benefit, that it is 
>>> easy
>>> to update the documentation, if the frontend is changed. This patch adds 
>>> doxygen
>>> tags to all the 32 bit versions of the tcg frontend operations, because the
>>> 64 bit version would mostly have the same documentation, and all the type
>>> conversition operations. The file tag has a note, that makes the user aware 
>>> of
>>> the missing 64 operations. In this version all the immediate variants are 
>>> also
>>> documented by simply refering to the non immediate version. However I'm 
>>> willing
>>> to drop that.
>>> Any comments?
>> The operations (or at least most of them) are already documented in
>> tcg/README. If this change is accepted, I'd rather move the contents of the
>> README file into here.
> The README file contains IIRC only operation, which are also represented by 
> the
> intermediate format of tcg. Unfortunately this excludes useful helpers like
> subfi. So Richard suggested commenting the header file. However I wouldn't add
> only those helpers like subfi to the doxygen documentation, since the idea is 
> to
> have a good overview. If you have another suggestion I'm happy to hear it :).

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.


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