libxl: Provide doc comments for AO_GC and STATE_AO_GC

CC: Andrew Cooper <andrew.cooper3@citrix.com>
Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>

diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index 7129aeeb8fa2f5f28ec956cd0786335a64c15572..1ead0282dd9f47ab3e2a4ff82e20ee89f6a39de1 100644 (file)
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -2067,9 +2067,22 @@ _hidden void libxl__egc_cleanup(libxl__egc *egc);
         (rc);                                                   \
     })
 
+
+/*
+ * Given, in scope,
+ *   libxl__ao *ao;
+ * produces, in scope,
+ *   libxl__gc *gc;
+ */
 #define AO_GC                                   \
     libxl__gc *const gc __attribute__((unused)) = &ao->gc
 
+/*
+ * void STATE_AO_GC(libxl__ao *ao_spec);
+ * // Produces, in scope:
+ *   libxl__ao *ao;  // set from ao_spec
+ *   libxl__gc *gc;
+ */
 #define STATE_AO_GC(op_ao)                      \
     libxl__ao *const ao = (op_ao);              \
     libxl__gc *const gc __attribute__((unused)) = libxl__ao_inprogress_gc(ao)