specs/XKB: Manual fixup of parameter markup

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
This commit is contained in:
Alan Coopersmith 2014-07-10 15:00:30 -07:00
parent 5526dce681
commit 6b96259dab
12 changed files with 60 additions and 60 deletions

View file

@ -663,7 +663,7 @@ Device, Feedback Class, or Feedback ID invalid
The Xkb extension adds a single protocol error,
<errorname>BadKeyboard</errorname>,
to the core protocol error set. This error code will be reported as the
<emphasis>error_rtrn</emphasis>
<parameter>error_rtrn</parameter>
when
<function>XkbQueryExtension</function>
is called. When a

View file

@ -883,9 +883,9 @@ To receive
and pass
<symbol>XkbStateNotifyMask</symbol>
in both
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>.
<parameter>values_for_bits</parameter>.
</para>
@ -899,9 +899,9 @@ To receive
as the
<structfield>event_type</structfield>
and specifying the desired state changes in
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
using mask bits from <link linkend="table5.3">Table 5.3</link>.
</para>

View file

@ -1179,13 +1179,9 @@ indicator is mapped to a physical LED, the
<para>
Each of the "
<emphasis>_rtrn</emphasis>
" arguments is optional; you can pass
Each of the "<parameter>_rtrn</parameter>" arguments is optional; you can pass
<symbol>NULL</symbol>
for any unneeded "
<emphasis>_rtrn</emphasis>
" arguments.
for any unneeded "<parameter>_rtrn</parameter>" arguments.
</para>
@ -1745,9 +1741,9 @@ To receive
events, use
<function>XkbSelectEvents</function>
(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) with both the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameters containing
<symbol>XkbIndicatorStateNotifyMask</symbol>.
To receive
@ -1769,9 +1765,9 @@ Set the
or
<symbol>XkbIndicatorMapNotify</symbol>,
and set both the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
detail parameters to a mask where each bit specifies one indicator, turning on
those bits that specify the indicators for which you want to receive events.
</para>

View file

@ -560,7 +560,9 @@ Otherwise,
calls
<function>XkbDeviceBell</function>
with the specified
<emphasis>display, window, percent</emphasis>,
<parameter>display</parameter>,
<parameter>window</parameter>,
<parameter>percent</parameter>,
and
<parameter>name</parameter>,
a
@ -812,7 +814,9 @@ Otherwise,
calls
<function>XkbDeviceBellEvent</function>
with the specified
<emphasis>display, window, percent</emphasis>,
<parameter>display</parameter>,
<parameter>window</parameter>,
<parameter>percent</parameter>,
and
<parameter>name</parameter>,
a
@ -1069,9 +1073,9 @@ To receive
events under all possible conditions, pass
<symbol>XkbBellNotifyMask</symbol>
in both the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameters to
<function>XkbSelectEvents</function>
(see <link linkend="Selecting_Xkb_Events">section 4.3</link>).
@ -1090,9 +1094,9 @@ can call
and specifying
<symbol>XkbAllBellEventsMask</symbol>
in
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>.
<parameter>values_for_bits</parameter>.
This has the same effect as a call to
<function>XkbSelectEvents</function>.
</para>

View file

@ -2115,9 +2115,9 @@ To receive
(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
<symbol>XkbAccessXNotifyMask</symbol>
in both
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>.
<parameter>values_for_bits</parameter>.
</para>
@ -2131,9 +2131,9 @@ To receive
as the
<structfield>event_type</structfield>
and specifying the desired state changes in
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
using mask bits from <link linkend="table10.5">Table 10.5</link>.
</para>
@ -4725,9 +4725,9 @@ description, the server sends an
(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
<symbol>XkbControlsNotifyMask</symbol>
in both
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>.
<parameter>values_for_bits</parameter>.
</para>
@ -4741,9 +4741,9 @@ To receive
as the
<structfield>event_type</structfield>
and specifying the desired state changes in
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
using mask bits from <link linkend="table10.7">Table 10.7</link>.
</para>
@ -4920,7 +4920,7 @@ specified in <link linkend="table10.7">Table 10.7</link> with "ok" in the
and specified in
<parameter>wanted</parameter>
into the changes record specified by
<emphasis>old</emphasis>.
<parameter>changes</parameter>.
</para>

View file

@ -1294,8 +1294,8 @@ If
is
<symbol>NULL</symbol>,
the top surface is defined as the last outline in the
<parameter>shape</parameter>
s array of outlines.
<parameter>shape</parameter>s
array of outlines.
<function>XkbComputeShapeTop</function>
returns
<symbol>False</symbol>

View file

@ -990,9 +990,9 @@ To receive
(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
<symbol>XkbMapNotifyMask</symbol>
in both
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>.
<parameter>values_for_bits</parameter>.
</para>
@ -1006,9 +1006,9 @@ To receive
as the
<structfield>event_type</structfield>
and specifying the desired map changes in
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
using mask bits from <link linkend="table14.1">Table 14.1</link>.
</para>

View file

@ -421,7 +421,7 @@ corresponding to
returns the key action corresponding to group
<parameter>grp</parameter>
and shift level
<emphasis>lvl</emphasis>
<parameter>shift</parameter>
from the two-dimensional table of key actions associated with the key
corresponding to
<parameter>keycode</parameter>.
@ -2986,9 +2986,9 @@ To receive
and pass
<symbol>XkbActionMessageMask</symbol>
in both
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>.
<parameter>values_for_bits</parameter>.
</para>
@ -3004,9 +3004,9 @@ The
and specifying
<symbol>XkbAllActionMessagesMask</symbol>
in
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>.
<parameter>values_for_bits</parameter>.
This has the same effect as a call to
<function>XkbSelectEvents</function>.
</para>

View file

@ -1364,8 +1364,8 @@ the vector of
copies compatibility map information from the keyboard description in
<parameter>xkb</parameter>
to the server specified in
<parameter>display</parameter>
s compatibility map for the device specified by the
<parameter>display</parameter>s
compatibility map for the device specified by the
<structfield>device_spec</structfield>
field of
<parameter>xkb</parameter>.
@ -1535,9 +1535,9 @@ To receive
(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) and pass
<symbol>XkbCompatMapNotifyMask</symbol>
in both
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>.
<parameter>values_for_bits</parameter>.
</para>
@ -1551,9 +1551,9 @@ To receive
as the
<structfield>event_type</structfield>
and specifying the desired map changes in
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
using mask bits from <link linkend="table17.2">Table 17.2</link>.
</para>

View file

@ -447,7 +447,7 @@ If the
obtains the values specified by
<parameter>which</parameter>
and copies them into the keyboard description
<emphasis>Xkb</emphasis>.
<parameter>xkb</parameter>.
</para>
@ -840,9 +840,9 @@ server sends a
(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) with
<symbol>XkbNamesNotifyMask</symbol>
in both the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameters.
</para>
@ -855,9 +855,9 @@ Set the
parameter to
<symbol>XkbNamesNotify</symbol>,
and set both the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
detail parameter to a mask composed of a bitwise OR of masks in
<link linkend="table18.1">Table 18.1</link>.
</para>

View file

@ -190,9 +190,9 @@ To receive name notify events, use
(see <link linkend="Selecting_Xkb_Events">section 4.3</link>) with
<symbol>XkbNewKeyboardNotifyMask</symbol>
in both the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
parameters. To receive events for only specific names, use
<function>XkbSelectEventDetails</function>.
Set the
@ -200,9 +200,9 @@ Set the
parameter to
<symbol>XkbNewKeyboardNotify</symbol>,
and set both the
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>
<parameter>values_for_bits</parameter>
detail parameter to a mask composed of a bitwise OR of masks in
<link linkend="table19.1">Table 19.1</link>.
</para>

View file

@ -1778,9 +1778,9 @@ To receive
and pass
<symbol>XkbExtensionDeviceNotifyMask</symbol>
in both
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>.
<parameter>values_for_bits</parameter>.
</para>
@ -1796,9 +1796,9 @@ The
and specifying
<symbol>XkbAllExtensionDeviceEventsMask</symbol>
in
<emphasis>bits_to_change</emphasis>
<parameter>bits_to_change</parameter>
and
<emphasis>values_for_bits</emphasis>.
<parameter>values_for_bits</parameter>.
This has the same effect as a call to
<function>XkbSelectEvents</function>.
</para>