[Xen-devel] [PATCH 7 of 8 DOCDAY] docs: hypercall: generate docs for latest API

[Ian Campbell <ian.campbell@xxxxxxxxxx>]

# HG changeset patch
# User Ian Campbell <ian.campbell@xxxxxxxxxx>
# Date 1319625725 -3600
# Node ID 1dd6bb4612b4f11bf52fa7ac21321227b6560e0e
# Parent  ae4ea5cb066383e9bfe30ab49fd498eed0d5ca7e
docs: hypercall: generate docs for latest API

By defining __XEN_INTERFACE_VERSION__=__XEN_LATEST_INTERFACE_VERSION__.

I'm not entirely happy with how guest handles are represented in the output.

Signed-off-by: Ian Campbell <ian.campbell@xxxxxxxxxx>

diff --git a/docs/hypercall.Doxyfile b/docs/hypercall.Doxyfile
--- a/docs/hypercall.Doxyfile
+++ b/docs/hypercall.Doxyfile
@@ -170,7 +170,7 @@ SEPARATE_MEMBER_PAGES  = NO
 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
 # Doxygen uses this value to replace tabs by spaces in code fragments.
 
-TAB_SIZE               = 8
+TAB_SIZE               = 4
 
 # This tag can be used to specify a number of aliases that acts
 # as commands in the documentation. An alias has the form "name=value".
@@ -1331,13 +1331,13 @@ ENABLE_PREPROCESSING   = YES
 # compilation will be performed. Macro expansion can be done in a controlled
 # way by setting EXPAND_ONLY_PREDEF to YES.
 
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
 # then the macro expansion is limited to the macros specified with the
 # PREDEFINED and EXPAND_AS_DEFINED tags.
 
-EXPAND_ONLY_PREDEF     = NO
+EXPAND_ONLY_PREDEF     = YES
 
 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
 # in the INCLUDE_PATH (see below) will be search if a #include is found.
@@ -1365,7 +1365,11 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator
 # instead of the = operator.
 
-PREDEFINED             =
+PREDEFINED             = 
"__XEN_INTERFACE_VERSION__=__XEN_LATEST_INTERFACE_VERSION__" \
+                         "XEN_GUEST_HANDLE(name)=GUEST_##name *" \
+                         "XEN_GUEST_HANDLE_64(name)= GUEST_##name *" \
+                         "DEFINE_XEN_GUEST_HANDLE(name)=typedef name 
GUEST_##name;typedef const name GUEST_const_##name" \
+                         "__DEFINE_XEN_GUEST_HANDLE(name,type)=typedef name 
GUEST_##name; typedef const type GUEST_const_##name"
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be 
expanded.

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