Re: [libvirt] [PATCH] docs: fix documentation of enum constants
On Fri, Jul 21, 2017 at 01:03:13PM +0200, Michal Privoznik wrote:
On 07/21/2017 01:01 PM, Daniel P. Berrange wrote:
> On Fri, Jul 21, 2017 at 12:58:55PM +0200, Michal Privoznik wrote:
>> <snip/>
>> Yeah. Our generator is not that great. I wish that we'd switch to
>> something already out there so that we don't have to maintain our own
>> generator.
>
> There's a good few options for docs generators. Unfortunately our code
> is also used for generating the XML API description, that's in turn
> used to generate some language bindings, and I don't know of any tools
> that could replace that part. So it looks like we're stuck as long as
> we want to support auto-generated bindings from the XML description
Well we can use proper doc generator for generating doc and then our own
generator for generating the XML API description. BTW: what good options
do you have in mind?
Doxygen, Sphinx, GTK-DOC, though I would not be in favour of Doxygen as
IMHO the docs it generates have awful navigation. QEMU is switching to
use Sphinx IIRC.
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|