WARNING - OLD ARCHIVES

This is an archived copy of the Xen.org mailing list, which we have preserved to ensure that existing links to archives are not broken. The live archive, which contains the latest emails, can be found at http://lists.xen.org/
   
 
 
Xen 
 
Home Products Support Community News
 
   
 

xen-devel

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

To: Ian Campbell <ian.campbell@xxxxxxxxxx>
Subject: Re: [Xen-devel] [PATCH 0 of 8 DOCDAY] setup Doxygen for use with hypercall interface headers
From: Ian Jackson <Ian.Jackson@xxxxxxxxxxxxx>
Date: Wed, 26 Oct 2011 14:50:59 +0100
Cc: xen-devel@xxxxxxxxxxxxxxxxxxx
Delivery-date: Wed, 26 Oct 2011 06:51:33 -0700
Envelope-to: www-data@xxxxxxxxxxxxxxxxxxx
In-reply-to: <patchbomb.1319634159@xxxxxxxxxxxxxxxxxxxxxxxxx>
List-help: <mailto:xen-devel-request@lists.xensource.com?subject=help>
List-id: Xen developer discussion <xen-devel.lists.xensource.com>
List-post: <mailto:xen-devel@lists.xensource.com>
List-subscribe: <http://lists.xensource.com/mailman/listinfo/xen-devel>, <mailto:xen-devel-request@lists.xensource.com?subject=subscribe>
List-unsubscribe: <http://lists.xensource.com/mailman/listinfo/xen-devel>, <mailto:xen-devel-request@lists.xensource.com?subject=unsubscribe>
Newsgroups: chiark.mail.xen.devel
References: <patchbomb.1319634159@xxxxxxxxxxxxxxxxxxxxxxxxx>
Sender: xen-devel-bounces@xxxxxxxxxxxxxxxxxxx
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