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

[Ian Jackson <Ian.Jackson@xxxxxxxxxxxxx>]

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).

Ian.

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