All of lore.kernel.org
 help / color / mirror / Atom feed
From: Ian Campbell <ian.campbell@citrix.com>
To: xen-devel@lists.xensource.com
Cc: Ian Campbell <ian.campbell@citrix.com>
Subject: [PATCH 0 of 8 DOCDAY] setup Doxygen for use with hypercall interface headers
Date: Wed, 26 Oct 2011 14:02:39 +0100	[thread overview]
Message-ID: <patchbomb.1319634159@cosworth.uk.xensource.com> (raw)

The following series sets up a Doxygen run over xen/include/public and
makes a start at documenting some hypercalls.

I only did mmuext_op so far since I wanted to validate the approach
with the list before persisting any further. I'm not that convinced by
the effect on the readability of the headers but hopefully this is
offset by the ability to generate nice HTML docs?

I hope that this can eventually replace the extremely out of date
(although it's actualy not aged that badly in parts, I've stolen a
paragraph or two already) interfaces.tex with something which people
might actually keep up to date.

One quirk is that hypercalls are generally defined by #defines and
structs and not by actual function calls which does not play well to
Doxygen's strengths. I decided to do the following:
#ifdef __DOXYGEN__
int HYPERVISOR_mmuext_op(
    XEN_GUEST_HANDLE(mmuext_op_t) uops,
    unsigned int count,
    XEN_GUEST_HANDLE(uint) pdone,
    unsigned int foreigndom);
#endif

Combined with creating a Doxygen group for each hypercall (in order to
pull all the #defines etc in to one page) it comes out looking OK:
http://xenbits.xen.org/people/ianc/docs/group__HYPERVISOR__mmuext__op.html

Any thoughts or shall I move onto the next hypercall?

             reply	other threads:[~2011-10-26 13:02 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-10-26 13:02 Ian Campbell [this message]
2011-10-26 13:02 ` [PATCH 1 of 8 DOCDAY] docs: rename python Doxygen files to allow for other Doxygen uses Ian Campbell
2011-10-26 13:02 ` [PATCH 2 of 8 DOCDAY] docs: python: add quotes to PROJECT_NAME Ian Campbell
2011-10-26 13:02 ` [PATCH 3 of 8 DOCDAY] docs: python: strip build directory prefix from python modules Ian Campbell
2011-10-26 13:02 ` [PATCH 4 of 8 DOCDAY] docs: python: run "doxygen -u docs/python.Doxyfile" Ian Campbell
2011-10-26 13:02 ` [PATCH 5 of 8 DOCDAY] docs: hypercall: initial autogenerated version of hypercall.Doxyfile Ian Campbell
2011-10-26 13:02 ` [PATCH 6 of 8 DOCDAY] docs: hypercall: tailor doxygen configuration and hook into build Ian Campbell
2011-10-26 13:02 ` [PATCH 7 of 8 DOCDAY] docs: hypercall: generate docs for latest API Ian Campbell
2011-10-26 13:02 ` [PATCH 8 of 8 DOCDAY] docs: hypercall: document mmuext_op using Doxygen Ian Campbell
2011-10-26 13:43   ` David Vrabel
2011-10-26 13:50 ` [PATCH 0 of 8 DOCDAY] setup Doxygen for use with hypercall interface headers Ian Jackson
2011-10-26 13:56   ` Ian Campbell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=patchbomb.1319634159@cosworth.uk.xensource.com \
    --to=ian.campbell@citrix.com \
    --cc=xen-devel@lists.xensource.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.