summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@oracle.com>2023-08-20 15:11:04 -0700
committerAlan Coopersmith <alan.coopersmith@oracle.com>2023-08-20 15:27:48 -0700
commit44f908d9283710ffc75b22d2ae7a8948119b3e61 (patch)
tree7dddd26ecc7abda6e43e3cb3cc5cf6313fbc8767
parent7b16c55063ba4eb258bf91c170e378c1e2d398bd (diff)
docs: fix names for XkbKeyKeyType & XkbKeyKeyTypeIndex
Implementation had "Key" twice in these macro names, but the docs had only listed it once. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
-rw-r--r--man/xkb/Makefile.am4
-rw-r--r--man/xkb/XkbGetKeyTypes.man4
-rw-r--r--man/xkb/XkbKeyKeyType.man (renamed from man/xkb/XkbKeyType.man)8
-rw-r--r--man/xkb/XkbKeyKeyTypeIndex.man (renamed from man/xkb/XkbKeyTypeIndex.man)8
-rw-r--r--specs/XKB/ch15.xml16
5 files changed, 20 insertions, 20 deletions
diff --git a/man/xkb/Makefile.am b/man/xkb/Makefile.am
index 043d2aed..411f03b5 100644
--- a/man/xkb/Makefile.am
+++ b/man/xkb/Makefile.am
@@ -122,13 +122,13 @@ libman_PRE = \
XkbKeyGroupWidth.man \
XkbKeyGroupsWidth.man \
XkbKeyHasActions.man \
+ XkbKeyKeyType.man \
+ XkbKeyKeyTypeIndex.man \
XkbKeyNumActions.man \
XkbKeyNumGroups.man \
XkbKeyNumSyms.man \
XkbKeySymEntry.man \
XkbKeySymsPtr.man \
- XkbKeyType.man \
- XkbKeyTypeIndex.man \
XkbKeyTypesForCoreSymbols.man \
XkbKeycodeToKeysym.man \
XkbKeysymToModifiers.man \
diff --git a/man/xkb/XkbGetKeyTypes.man b/man/xkb/XkbGetKeyTypes.man
index aad302a8..d904ac6f 100644
--- a/man/xkb/XkbGetKeyTypes.man
+++ b/man/xkb/XkbGetKeyTypes.man
@@ -77,6 +77,6 @@ The Xkb extension has not been properly initialized
.B BadValue
An argument is out of range
.SH "SEE ALSO"
-.BR XkbKeyType (__libmansuffix__),
-.BR XkbKeyTypeIndex (__libmansuffix__)
+.BR XkbKeyKeyType (__libmansuffix__),
+.BR XkbKeyKeyTypeIndex (__libmansuffix__)
diff --git a/man/xkb/XkbKeyType.man b/man/xkb/XkbKeyKeyType.man
index b7cb2e0c..1dfd224a 100644
--- a/man/xkb/XkbKeyType.man
+++ b/man/xkb/XkbKeyKeyType.man
@@ -20,12 +20,12 @@
.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
.\" DEALINGS IN THE SOFTWARE.
.\"
-.TH XkbKeyType __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
+.TH XkbKeyKeyType __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
-XkbKeyType \- Obtain the index of a key type or the pointer to a key type
+XkbKeyKeyType \- Obtain the index of a key type or the pointer to a key type
.SH SYNOPSIS
.HP
-.B XkbKeyTypePtr XkbKeyType
+.B XkbKeyTypePtr XkbKeyKeyType
.BI "(\^XkbDescPtr " "xkb" "\^,"
.BI "KeyCode " "keycode" "\^,"
.BI "int " "group" "\^);"
@@ -43,7 +43,7 @@ keycode of interest
group index
.SH DESCRIPTION
.LP
-.I XkbKeyType
+.I XkbKeyKeyType
returns a pointer to the key type in the
.I types
vector of the client map in
diff --git a/man/xkb/XkbKeyTypeIndex.man b/man/xkb/XkbKeyKeyTypeIndex.man
index ea77bf31..677c085f 100644
--- a/man/xkb/XkbKeyTypeIndex.man
+++ b/man/xkb/XkbKeyKeyTypeIndex.man
@@ -20,12 +20,12 @@
.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
.\" DEALINGS IN THE SOFTWARE.
.\"
-.TH XkbKeyTypeIndex __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
+.TH XkbKeyKeyTypeIndex __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
-XkbKeyTypeIndex \- Obtain the index of a key type or the pointer to a key type
+XkbKeyKeyTypeIndex \- Obtain the index of a key type or the pointer to a key type
.SH SYNOPSIS
.HP
-.B int XkbKeyTypeIndex
+.B int XkbKeyKeyTypeIndex
.BI "(\^XkbDescPtr " "xkb" "\^,"
.BI "KeyCode " "keycode" "\^,"
.BI "int " "group" "\^);"
@@ -43,7 +43,7 @@ keycode of interest
group index
.SH DESCRIPTION
.LP
-.I XkbKeyTypeIndex
+.I XkbKeyKeyTypeIndex
computes an index into the
.I types
vector of the client map in
diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml
index c7a5a96a..12b6404a 100644
--- a/specs/XKB/ch15.xml
+++ b/specs/XKB/ch15.xml
@@ -1304,10 +1304,10 @@ currently four); if a key has fewer than
<symbol>XkbNumKbdGroups</symbol>
groups, the extra key types are reported but ignored.</para></note>
-<indexterm significance="preferred" zone="XkbKeyTypeIndex"><primary><function>XkbKeyTypeIndex</function></primary></indexterm>
-<funcsynopsis id="XkbKeyTypeIndex">
+<indexterm significance="preferred" zone="XkbKeyKeyTypeIndex"><primary><function>XkbKeyKeyTypeIndex</function></primary></indexterm>
+<funcsynopsis id="XkbKeyKeyTypeIndex">
<funcprototype>
- <funcdef>int <function>XkbKeyTypeIndex</function></funcdef>
+ <funcdef>int <function>XkbKeyKeyTypeIndex</function></funcdef>
<!-- (
<parameter>xkb, keycode, group</parameter>
) /* macro*/ -->
@@ -1351,7 +1351,7 @@ groups, the extra key types are reported but ignored.</para></note>
</variablelist>
<para>
-<function>XkbKeyTypeIndex</function>
+<function>XkbKeyKeyTypeIndex</function>
computes an index into the
<structfield>types</structfield>
vector of the client map in
@@ -1364,10 +1364,10 @@ index.
</para>
-<indexterm significance="preferred" zone="XkbKeyType"><primary><function>XkbKeyType</function></primary></indexterm>
-<funcsynopsis id="XkbKeyType">
+<indexterm significance="preferred" zone="XkbKeyKeyType"><primary><function>XkbKeyKeyType</function></primary></indexterm>
+<funcsynopsis id="XkbKeyKeyType">
<funcprototype>
- <funcdef>XkbKeyTypePtr <function>XkbKeyType</function></funcdef>
+ <funcdef>XkbKeyTypePtr <function>XkbKeyKeyType</function></funcdef>
<!-- (
<parameter>xkb, keycode, group</parameter>
) /* macro */ -->
@@ -1411,7 +1411,7 @@ index.
</variablelist>
<para>
-<function>XkbKeyType</function>
+<function>XkbKeyKeyType</function>
returns a pointer to the key type in the
<structfield>types</structfield>
vector of the client map in