[libvirt] minor doc generation glitch

Eric Blake eblake at redhat.com
Wed Jun 15 21:21:44 UTC 2011


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.

-- 
Eric Blake   eblake at redhat.com    +1-801-349-2682
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 620 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20110615/b0d9f827/attachment-0001.sig>


More information about the libvir-list mailing list