Document enum, altenum, and mask
authorPeter Harris <pharris@opentext.com>
Thu, 5 Feb 2009 21:09:05 +0000 (16:09 -0500)
committerPeter Harris <pharris@opentext.com>
Thu, 19 Feb 2009 20:00:30 +0000 (15:00 -0500)
Signed-off-by: Peter Harris <pharris@opentext.com>
doc/xml-xcb.txt

index 5d34754..feb9984 100644 (file)
@@ -178,6 +178,12 @@ separated by a single colon.  For example, to refer to the PIXMAP type defined
 in glx rather than the one defined in xproto, use type="glx:PIXMAP" rather
 than type="PIXMAP".
 
+Note: Most of the below may optionally contain an enum, altenum, or mask
+attribute, which follows the above rules for "type". "enum" is an exhaustive
+enum; the value is restricted to one of the constants named in the enum.
+"altenum" may be one of the values contained in the enum, but it need not be.
+"mask" refers to an enum to be used as a bitmask.
+
 <pad bytes="integer" />
 
   This element declares some padding in a data structure.  The bytes