Re: [libvirt] minor doc generation glitch
On Thu, Jun 16, 2011 at 01:19:47PM +0800, Daniel Veillard wrote:
On Wed, Jun 15, 2011 at 03:21:44PM -0600, Eric Blake wrote:
> On 06/15/2011 01:25 PM, Eric Blake wrote:
> > Looking at
> > http://libvirt.org/html/libvirt-libvirt.html#virDomainShutoffReason as
> > an example, I see several places where there are spurious "*" in the
> > generated documentation.
>
> Also, http://libvirt.org/html/libvirt-libvirt.html#virTypedParameter is
> broken, listing 'charfield[length] field' rather than 'char[length]
> field' or 'char field[length]' for the first member, and completely
> missing out on the 'union{} value' member. It's okay if the docs
don't
> list structs in C syntax, but whatever syntax it does use should be
> close enough to figure out the corresponding C syntax without having to
> read the source header to check for missing struct members.
I'm fixing those, nearly done ...
The enclosed patch includes quite a number of fixes
- parsing of "long long int" and similar
- add parsing of unions within a struct
- remove spurious " * " fron comments on structure fields and enums
- fix concatenation of base type and name in arrays
- extend XSLT to cope with union in structs
this is painful to read (this was apinful to write !), have a look at
the resulting libvirt-api.xml and generated page, that's the nicest way
to validate it :-)
Daniel
--
Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/
daniel(a)veillard.com | Rpmfind RPM search engine http://rpmfind.net/
http://veillard.com/ | virtualization library http://libvirt.org/
Attachments:
- apibuild.patch (text/plain — 14.5 KB)