summaryrefslogtreecommitdiff
path: root/specs
diff options
context:
space:
mode:
authorThomas E. Dickey <dickey@invisible-island.net>2019-06-06 21:01:06 -0400
committerThomas E. Dickey <dickey@his.com>2019-06-10 00:27:23 +0000
commit3d65748dee9a6d2e34b7cafec09b1ec7a6f5eb43 (patch)
tree64f1cb0f9e492f7f3b6b3aa325dd433513c8c132 /specs
parentab1b99130f98a3767589519c37ce78b3dcb8ce8e (diff)
downloadxorg-lib-libXt-3d65748dee9a6d2e34b7cafec09b1ec7a6f5eb43.tar.gz
correct markup for header- and library-filenames; they are not functions
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
Diffstat (limited to 'specs')
-rw-r--r--specs/CH01.xml57
-rw-r--r--specs/CH04.xml10
-rw-r--r--specs/CH06.xml4
-rw-r--r--specs/CH07.xml6
-rw-r--r--specs/CH09.xml8
-rw-r--r--specs/CH11.xml2
-rw-r--r--specs/CH12.xml18
-rw-r--r--specs/CH13.xml2
-rw-r--r--specs/appB.xml2
-rw-r--r--specs/appE.xml4
10 files changed, 57 insertions, 56 deletions
diff --git a/specs/CH01.xml b/specs/CH01.xml
index b35ba7a..e208a3c 100644
--- a/specs/CH01.xml
+++ b/specs/CH01.xml
@@ -77,29 +77,29 @@ any module, widget, or application that calls an Intrinsics procedure.
<para>
Applications that use the Intrinsics mechanisms
must include the header files
-<function>&lt;X11/Intrinsic.h&gt;</function>
+<filename class="headerfile">&lt;X11/Intrinsic.h&gt;</filename>
and
-<function>&lt;X11/StringDefs.h&gt;</function>,
+<filename class="headerfile">&lt;X11/StringDefs.h&gt;</filename>,
or their equivalent,
and they may also include
-<function>&lt;X11/Xatoms.h&gt;</function>
+<filename class="headerfile">&lt;X11/Xatoms.h&gt;</filename>
and
-<function>&lt;X11/Shell.h&gt;</function>.
+<filename class="headerfile">&lt;X11/Shell.h&gt;</filename>.
In addition, widget implementations should include
-<function>&lt;X11/IntrinsicP.h&gt;</function>
+<filename class="headerfile">&lt;X11/IntrinsicP.h&gt;</filename>
instead of
-<function>&lt;X11/Intrinsic.h&gt;</function>.
+<filename class="headerfile">&lt;X11/Intrinsic.h&gt;</filename>.
</para>
<para>
The applications must also include the additional header files for
each widget class that they are to use (for example,
-<function>&lt;X11/Xaw/Label.h&gt;</function>
+<filename class="headerfile">&lt;X11/Xaw/Label.h&gt;</filename>
or
-<function>&lt;X11/Xaw/Scrollbar.h&gt;).</function>
+<filename class="headerfile">&lt;X11/Xaw/Scrollbar.h&gt;).</filename>
On a POSIX-based system,
the Intrinsics object library file is named
-<function>libXt.a</function>
+<filename class="libraryfile">libXt.a</filename>
and is usually referenced as -lXt when linking the application.
</para>
</sect1>
@@ -279,7 +279,7 @@ creating instances of Core are
<para>
In
-<function>IntrinsicP.h</function>:
+<filename class="headerfile">IntrinsicP.h</filename>:
</para>
<programlisting>
extern WidgetClassRec widgetClassRec;
@@ -287,7 +287,7 @@ extern WidgetClassRec widgetClassRec;
</programlisting>
<para>
In
-<function>Intrinsic.h</function>:
+<filename class="headerfile">Intrinsic.h</filename>:
</para>
<programlisting>
extern WidgetClass widgetClass, coreWidgetClass;
@@ -303,7 +303,7 @@ are defined for generic actions on widgets.
In order to make these types opaque and ensure that the compiler
does not allow applications to access private data, the Intrinsics use
incomplete structure definitions in
-<function>Intrinsic.h</function>:
+<filename class="headerfile">Intrinsic.h</filename>:
</para>
<programlisting>
typedef struct _WidgetClassRec *WidgetClass, *CoreWidgetClass;
@@ -368,7 +368,7 @@ to specific widget types.
In order to make these types opaque and ensure that the compiler
does not allow applications to access private data, the Intrinsics use
incomplete structure definitions in
-<function>Intrinsic.h</function>.
+<filename class="headerfile">Intrinsic.h</filename>.
</para>
<programlisting>
typedef struct _WidgetRec *Widget, *CoreWidget;
@@ -677,14 +677,14 @@ instances of Composite are
<para>
In
-<function>IntrinsicP.h</function>:
+<filename class="headerfile">IntrinsicP.h</filename>:
</para>
<programlisting>
extern CompositeClassRec compositeClassRec;
</programlisting>
<para>
In
-<function>Intrinsic.h</function>:
+<filename class="headerfile">Intrinsic.h</filename>:
</para>
<programlisting>
extern WidgetClass compositeWidgetClass;
@@ -703,7 +703,7 @@ The symbolic constant for the
version identifier is
<function>XtCompositeExtensionVersion</function>
(see <xref linkend='Class_Extension_Records' />).
-<function>Intrinsic.h</function>
+<filename class="headerfile">Intrinsic.h</filename>
uses an incomplete structure
definition to ensure that the compiler catches attempts to access
private data.
@@ -743,7 +743,7 @@ typedef struct {
} CompositeRec, *CompositeWidget;
</programlisting>
<para>
-<function>Intrinsic.h</function>
+<filename class="headerfile">Intrinsic.h</filename>
uses an incomplete structure definition to ensure that the
compiler catches attempts to access private data.
</para>
@@ -924,14 +924,14 @@ instances of Constraint are
<para>
In
-<function>IntrinsicP.h</function>:
+<filename class="headerfile">IntrinsicP.h</filename>:
</para>
<programlisting>
extern ConstraintClassRec constraintClassRec;
</programlisting>
<para>
In
-<function>Intrinsic.h</function>:
+<filename class="headerfile">Intrinsic.h</filename>:
</para>
<programlisting>
extern WidgetClass constraintWidgetClass;
@@ -951,7 +951,7 @@ The symbolic constant for the
version identifier is
<function>XtConstraintExtensionVersion</function>
(see <xref linkend='Class_Extension_Records' />).
-<function>Intrinsic.h</function>
+<filename class="headerfile">Intrinsic.h</filename>
uses an incomplete structure definition to ensure that the
compiler catches attempts to access private data.
</para>
@@ -990,7 +990,7 @@ typedef struct {
} ConstraintRec, *ConstraintWidget;
</programlisting>
<para>
-<function>Intrinsic.h</function>
+<filename class="headerfile">Intrinsic.h</filename>
uses an incomplete structure definition to ensure that the
compiler catches attempts to access private data.
</para>
@@ -1267,7 +1267,7 @@ the <emphasis remap='I'>background_pixmap</emphasis> field has the corresponding
XtNbackgroundPixmap,
which is defined as the string &ldquo;backgroundPixmap&rdquo;.
Many predefined names are listed in
-<function>&lt;X11/StringDefs.h&gt;</function>.
+<filename class="headerfile">&lt;X11/StringDefs.h&gt;</filename>.
Before you invent a new name,
you should make sure there is not already a name that you can use.
</para>
@@ -1280,7 +1280,7 @@ Each resource class string should have a symbolic identifier prefixed with
&ldquo;XtC&rdquo;
(for example, XtCBorderWidth).
Many predefined classes are listed in
-<function>&lt;X11/StringDefs.h&gt;</function>.
+<filename class="headerfile">&lt;X11/StringDefs.h&gt;</filename>.
</para>
</listitem>
<listitem>
@@ -1291,7 +1291,7 @@ Each representation string should have a symbolic identifier prefixed with
&ldquo;XtR&rdquo;
(for example, XtRTranslationTable).
Many predefined representation types are listed in
-<function>&lt;X11/StringDefs.h&gt;</function>.
+<filename class="headerfile">&lt;X11/StringDefs.h&gt;</filename>.
</para>
</listitem>
<listitem>
@@ -1456,7 +1456,7 @@ For example,
the public .h file for the
Constraint
widget class is
-<function>Constraint.h</function>.
+<filename class="headerfile">Constraint.h</filename>.
</para>
</sect2>
@@ -1626,7 +1626,7 @@ For example,
the private .h file for the
Constraint
widget class is
-<function>ConstrainP.h</function>.
+<filename class="headerfile">ConstrainP.h</filename>.
</para>
</sect2>
@@ -2009,7 +2009,7 @@ To check a widget's class
and to generate a debugging error message, use
<xref linkend='XtCheckSubclass' xrefstyle='select: title'/>,
defined in
-<function>&lt;X11/IntrinsicP.h&gt;</function>:
+<filename class="headerfile">&lt;X11/IntrinsicP.h&gt;</filename>:
</para>
<funcsynopsis id='XtCheckSubclass'>
@@ -2427,7 +2427,7 @@ is a procedure that issues an error message if it is actually called.
<para>
For example,
-<function>CompositeP.h</function>
+<filename class="headerfile">CompositeP.h</filename>
contains these definitions:
</para>
<programlisting>
@@ -2453,6 +2453,7 @@ static void CompositeClassPartInitialize(WidgetClass widgetClass)
.
.
.
+}
</programlisting>
<para>
Nonprocedure fields may be inherited in the same manner as procedure
diff --git a/specs/CH04.xml b/specs/CH04.xml
index c92eb20..e449e1b 100644
--- a/specs/CH04.xml
+++ b/specs/CH04.xml
@@ -399,17 +399,17 @@ Shell.
<para>
The declarations for all Intrinsics-defined shells except
VendorShell appear in
-<function>Shell.h</function>
+<filename class="headerfile">Shell.h</filename>
and
-<function>ShellP.h</function>.
+<filename class="headerfile">ShellP.h</filename>.
VendorShell has separate public and private .h files which are included by
-<function>Shell.h</function>
+<filename class="headerfile">Shell.h</filename>
and
-<function>ShellP.h</function>.
+<filename class="headerfile">ShellP.h</filename>.
</para>
<para>
-<function>Shell.h</function>
+<filename class="headerfile">Shell.h</filename>
uses incomplete structure definitions to ensure that the
compiler catches attempts to access private data in any of the Shell
instance or class data structures.
diff --git a/specs/CH06.xml b/specs/CH06.xml
index cdc1268..5e5b090 100644
--- a/specs/CH06.xml
+++ b/specs/CH06.xml
@@ -289,7 +289,7 @@ typedef enum {
<para>
The <emphasis remap='I'>request_mode</emphasis> definitions are from
-<function>&lt;X11/X.h&gt;</function>.
+<filename class="headerfile">&lt;X11/X.h&gt;</filename>.
</para>
<informaltable frame='none'>
@@ -376,7 +376,7 @@ structure the caller wants to specify.
<para>
The <emphasis remap='I'>stack_mode</emphasis> definitions are from
-<function>&lt;X11/X.h&gt;</function>:
+<filename class="headerfile">&lt;X11/X.h&gt;</filename>:
</para>
<informaltable frame='none'>
diff --git a/specs/CH07.xml b/specs/CH07.xml
index 7eefd04..6d8127f 100644
--- a/specs/CH07.xml
+++ b/specs/CH07.xml
@@ -626,7 +626,7 @@ call
and store the resulting identifier in a place accessible to the signal
handler. When a signal arrives, the signal handler should call
<xref linkend='XtNoticeSignal' xrefstyle='select: title'/>
-to notify the Intrinsics that a signal has occured. To register a signal
+to notify the Intrinsics that a signal has occurred. To register a signal
callback use
<xref linkend='XtAppAddSignal' xrefstyle='select: title'/>.
</para>
@@ -713,7 +713,7 @@ call.
</variablelist>
<para>
-To notify the Intrinsics that a signal has occured, use
+To notify the Intrinsics that a signal has occurred, use
<xref linkend='XtNoticeSignal' xrefstyle='select: title'/>.
</para>
@@ -2259,7 +2259,7 @@ The mask is the bitwise inclusive OR of any combination of
and
<function>XtIMSignal</function>.
As a convenience,
-<function>Intrinsic.h</function>
+<filename class="headerfile">Intrinsic.h</filename>
defines the symbolic name
<function>XtIMAll</function>
to be the bitwise inclusive OR of these four event types.
diff --git a/specs/CH09.xml b/specs/CH09.xml
index 8f1a5c6..76219db 100644
--- a/specs/CH09.xml
+++ b/specs/CH09.xml
@@ -84,7 +84,7 @@ sequence &ldquo;Xt&rdquo; are reserved to the Intrinsics for future standard and
implementation-dependent uses.
Widget header files typically contain a symbolic name for each resource name.
All resource names, classes, and types used by the Intrinsics are named in
-<function>&lt;X11/StringDefs.h&gt;</function>.
+<filename class="headerfile">&lt;X11/StringDefs.h&gt;</filename>.
The Intrinsics's symbolic resource names begin with
&ldquo;XtN&rdquo;
and are followed by the string name (for example, XtNbackgroundPixel
@@ -370,7 +370,7 @@ The Intrinsics define the following resource types:
</informaltable>
<para>
-<function>&lt;X11/StringDefs.h&gt;</function>
+<filename class="headerfile">&lt;X11/StringDefs.h&gt;</filename>
also defines the following resource types as a
convenience for widgets, although they do not have any corresponding
data type assigned:
@@ -1754,7 +1754,7 @@ an input value of representation type
Type converters use pointers to
<function>XrmValue</function>
structures (defined in
-<function>&lt;X11/Xresource.h&gt;;</function>
+<filename class="headerfile">&lt;X11/Xresource.h&gt;;</filename>
see <olink targetdoc='libX11' targetptr='Creating_and_Storing_Databases'>Section 15.4</olink> in
<olink targetdoc='libX11' targetptr='libX11'>Xlib &mdash; C Language X Interface.</olink>)
for input and output values.
@@ -2514,7 +2514,7 @@ and the structure
<function>XtConvertArgRec</function>
specify how each argument is derived.
These are defined in
-<function>&lt;X11/Intrinsic.h&gt;</function>.
+<filename class="headerfile">&lt;X11/Intrinsic.h&gt;</filename>.
</para>
<programlisting>
typedef enum {
diff --git a/specs/CH11.xml b/specs/CH11.xml
index 91f5f86..fc45a72 100644
--- a/specs/CH11.xml
+++ b/specs/CH11.xml
@@ -3277,7 +3277,7 @@ event.
<listitem>
<para>
Specifies the region object (as defined in
-<function>&lt;X11/Xutil.h&gt;</function>).
+<filename class="headerfile">&lt;X11/Xutil.h&gt;</filename>).
</para>
</listitem>
</varlistentry>
diff --git a/specs/CH12.xml b/specs/CH12.xml
index 531411d..70bc84f 100644
--- a/specs/CH12.xml
+++ b/specs/CH12.xml
@@ -141,14 +141,14 @@ are
<para>
In
-<function>IntrinsicP.h</function>:
+<filename class="headerfile">IntrinsicP.h</filename>:
</para>
<programlisting>
extern ObjectClassRec objectClassRec;
</programlisting>
<para>
In
-<function>Intrinsic.h</function>:
+<filename class="headerfile">Intrinsic.h</filename>:
</para>
<programlisting>
extern WidgetClass objectClass;
@@ -166,7 +166,7 @@ The symbolic constant for the
version identifier is
<function>XtObjectExtensionVersion</function>
(see <xref linkend='Class_Extension_Records' />).
-<function>Intrinsic.h</function>
+<filename class="headerfile">Intrinsic.h</filename>
uses an incomplete structure definition to ensure that the
compiler catches attempts to access private data:
</para>
@@ -207,7 +207,7 @@ object types.
<para>
In
-<function>IntrinsicP.h</function>:
+<filename class="headerfile">IntrinsicP.h</filename>:
</para>
<programlisting>
typedef struct _ObjectRec {
@@ -216,7 +216,7 @@ typedef struct _ObjectRec {
</programlisting>
<para>
In
-<function>Intrinsic.h</function>:
+<filename class="headerfile">Intrinsic.h</filename>:
</para>
<programlisting>
typedef struct _ObjectRec *Object;
@@ -571,14 +571,14 @@ are
<para>
In
-<function>Intrinsic.h</function>:
+<filename class="headerfile">Intrinsic.h</filename>:
</para>
<programlisting>
extern RectObjClassRec rectObjClassRec;
</programlisting>
<para>
In
-<function>Intrinsic.h</function>:
+<filename class="headerfile">Intrinsic.h</filename>:
</para>
<programlisting>
extern WidgetClass rectObjClass;
@@ -593,7 +593,7 @@ and the opaque variable
are defined for generic actions on objects
whose class is RectObj or a subclass of
RectObj.
-<function>Intrinsic.h</function>
+<filename class="headerfile">Intrinsic.h</filename>
uses an incomplete structure definition to ensure that the compiler
catches attempts to access private data:
</para>
@@ -637,7 +637,7 @@ typedef struct _RectObjRec {
</programlisting>
<para>
In
-<function>Intrinsic.h</function>:
+<filename class="headerfile">Intrinsic.h</filename>:
</para>
<programlisting>
typedef struct _RectObjRec* RectObj;
diff --git a/specs/CH13.xml b/specs/CH13.xml
index 9b6bc88..0b54bbd 100644
--- a/specs/CH13.xml
+++ b/specs/CH13.xml
@@ -591,7 +591,7 @@ the session manager in restarting applications based on the Intrinsics.
<para>
The resource name and class strings defined by the Intrinsics shell
widgets in
-<function>&lt;X11/Shell.h&gt;</function>
+<filename class="headerfile">&lt;X11/Shell.h&gt;</filename>
are now listed in Appendix E. The addition of a new symbol
for the
<function>WMShell</function>
diff --git a/specs/appB.xml b/specs/appB.xml
index f8396c5..0593746 100644
--- a/specs/appB.xml
+++ b/specs/appB.xml
@@ -830,7 +830,7 @@ corresponding Latin 1 KeySym, for example, &ldquo;0&rdquo; is the KeySym XK_0.
Other single character KeySyms are treated as literal constants from Latin 1,
for example, &ldquo;!&rdquo; is treated as 0x21.
Standard KeySym names are as defined in
-<function>&lt;X11/keysymdef.h&gt;</function>
+<filename>&lt;X11/keysymdef.h&gt;</filename>
with the &ldquo;XK_&rdquo; prefix removed.
</para>
diff --git a/specs/appE.xml b/specs/appE.xml
index de5da21..6c30964 100644
--- a/specs/appE.xml
+++ b/specs/appE.xml
@@ -5,7 +5,7 @@
<title>Defined Strings</title>
<para>
-The <function>StringDefs.h</function>
+The <filename class="headerfile">StringDefs.h</filename>
header file contains definitions for the following resource name,
class, and representation type symbolic constants.
</para>
@@ -1179,7 +1179,7 @@ class, and representation type symbolic constants.
<para>
The
-<function>Shell.h</function>
+<filename class="headerfile">Shell.h</filename>
header file contains definitions for the following resource name,
class, and representation type symbolic constants.
</para>