Re: [Xen-devel] [PATCH 0 of 8 DOCDAY] setup Doxygen for use with hypercall interface headers

[Ian Campbell <Ian.Campbell@xxxxxxxxxx>]

On Wed, 2011-10-26 at 14:50 +0100, Ian Jackson wrote:
> Ian Campbell writes ("[Xen-devel] [PATCH 0 of 8 DOCDAY] setup Doxygen for use 
> with hypercall interface headers"):
> > The following series sets up a Doxygen run over xen/include/public and
> > makes a start at documenting some hypercalls.
> 
> Urgh.  I really don't like doxygen.  doxygen-generated documents are
> very hard to navigate (and it encourages the writing of vacuous
> documentation comments).
> 
> Having looked at the various options, I think for hypercall
> documentation what we really want is a hyperlinked marked-up set of
> headerfiles, with a suitable contents page or index.
> 
> This is probably easiest to do with a little custom Perl script which
> can improve with time (a bit like the way kerneldoc probably started).

I think I agree it's a shame that one of the existing tools doesn't
better suit our needs. The docs outputted here aren't really all that
useful.

I'll see if I can knock something up...

Ian.



_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-devel