fdo-mirrors/xorg-xcbproto
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/xorg/proto/xcbproto.git synced 2026-05-05 09:58:05 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

xcb-doc: add paramref

Browse source 
The first paragraph of the description is loosely based on
a description proposed by Ran Benita.

Message-ID: <1410136150-30254-3-git-send-email-chris@demorecorder.com>
Patch-Thread-Subject: [Xcb] parametrized structs implemented
Patch-Set: ParametrizedStruct
Patch-Number: proto 3/5
Patch-Version: V1
Signed-off-by: Christian Linhart <chris@DemoRecorder.com>
This commit is contained in:
Christian Linhart 2014-09-08 02:29:08 +02:00
parent d8c5e82ab2
commit fffbd04d63
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/xml-xcb.txt
View file

@ -298,6 +298,23 @@ Expressions
the structure containing this expression. The identifier is the value of
the "name" attribute on the referenced field.
<paramref type="type">identifier</paramref>
A paramref is similar to a fieldref, but it refers to the value of
a field in the context which refers to the struct which contains the paramref.
So, it refers to a field outside of the structure where it is defined.
This has the following consequences:
* The generator cannot deduce its type.
So, it is mandatory to specify its type.
* The identifier-name must not be used as a field in the structure
which contaons the paramref.
For an example, see struct "DeviceTimeCoord" and request/reply
"GetDeviceMotionEvents" in xinput.xml, where paramref "num_axes"
in struct DeviceTimeCoord refers to field "num_axes" in
the DeviceTimeCoord reply.
<value>integer</value>
The value element represents a literal integer value in an expression. The