[libvirt] Parameters for macros in docs?

Hi all, The (autogenerated) docs aren't showing the parameters needed for the libvirt macros. For example, this is VIR_USE_CPU in the source: +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ /** * VIR_USE_CPU: * @cpumap: pointer to a bit map of real CPUs (in 8-bit bytes) (IN/OUT) * @cpu: the physical CPU number * * This macro is to be used in conjunction with virDomainPinVcpu() API. * USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap. */ #define VIR_USE_CPU(cpumap,cpu) (cpumap[(cpu)/8] |= (1<<((cpu)%8))) +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ In the API docs on the website, this is shown: +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ VIR_USE_CPU #define VIR_USE_CPU This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ To me, it makess sense to show the parameters needed for each macro. The information is passed along by the Python doc generation script, but is disregarded in the final XSLT transformation to produce the html docs. Wondering if that's on purpose, or are we ok to display the macro parameters too? Regards and best wishes, Justin Clift

On Mon, Jul 26, 2010 at 06:44:35PM +1000, Justin Clift wrote:
Hi all,
The (autogenerated) docs aren't showing the parameters needed for the libvirt macros.
[...]
The information is passed along by the Python doc generation script, but is disregarded in the final XSLT transformation to produce the html docs.
Wondering if that's on purpose, or are we ok to display the macro parameters too?
I think it's just that the XSLT inherited from libxml2 never needed macros with parameters, so that was never added. Feel free to hack the XSLT to add the arguments (code should be similar as for functions parameters as the input and output should be very similar, except the argument has no type). thanks ! Daniel -- Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/ daniel@veillard.com | Rpmfind RPM search engine http://rpmfind.net/ http://veillard.com/ | virtualization library http://libvirt.org/
participants (2)
-
Daniel Veillard
-
Justin Clift