Re: [Xen-devel] [PATCH 8 of 8 DOCDAY] docs: hypercall: document mmuext_op using Doxygen

[David Vrabel <david.vrabel@xxxxxxxxxx>]

On 26/10/11 14:02, Ian Campbell wrote:
> 
> + * An additional MMU hypercall provides an `extended command'
> + * interface. This provides additional functionality beyond the basic
> + * table updating commands. This hypercall is used to perform
> + * additional MMU operations. These include updating cr3 (or just
> + * re-installing it for a TLB flush), requesting various kinds of TLB
> + * flush, flushing the cache, installing a new LDT, or pinning &
> + * unpinning page-table pages (to ensure their reference count doesn’t
> + * drop to zero which would require a revalidation of all entries).

Bullet points linked to the docs for the specific op might be more
useful here (rather than the long comma-separated list).


> +/** \ingroup HYPERVISOR_mmuext_op

Consider using the @{ @} markers to put adjacent items into the same
group rather than having \ingroup for each item.

David

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