Commit 4b91ed09 authored by Alan Coopersmith's avatar Alan Coopersmith

X.Org Bug #4312: incorrect comment asterisk in XAnyEvent.3x man page

X.Org Bugzilla #4312 <http://bugs.freedesktop.org/show_bug.cgi?id=4312>

Protect /* sequences from cpp pre-processor removal without transforming
to Unicode mathematical asterisk character
parent 2af660c2
......@@ -305,9 +305,9 @@ structure contains:
.TA .5i 3i
.ta .5i 3i
typedef struct {
int family; /\(** for example FamilyInternet */
int length; /\(** length of address, in bytes */
char *address; /\(** pointer to where to find the address */
int family; /\&* for example FamilyInternet */
int length; /\&* length of address, in bytes */
char *address; /\&* pointer to where to find the address */
} XHostAddress;
.De
.LP
......@@ -331,10 +331,10 @@ structure which contains:
.TA .5i 3i
.ta .5i 3i
typedef struct {
int typelength; /\(** length of type string, in bytes */
int valuelength; /\(** length of value string, in bytes */
char *type; /\(** pointer to where to find the type string */
char *value; /\(** pointer to where to find the address */
int typelength; /\&* length of type string, in bytes */
int valuelength; /\&* length of value string, in bytes */
char *type; /\&* pointer to where to find the type string */
char *value; /\&* pointer to where to find the address */
} XServerInterpretedAddress;
.De
.LP
......
......@@ -324,7 +324,7 @@ The
.ZN XSizeHints
structure contains:
.LP
/\(** Size hints mask bits */
/\&* Size hints mask bits */
.TS
lw(.5i) lw(1.1i) lw(1.5i) lw(3.1i).
T{
......@@ -334,7 +334,7 @@ T} T{
T} T{
(1L << 0)
T} T{
/\(** user specified x, y */
/\&* user specified x, y */
T}
T{
\&#define
......@@ -343,7 +343,7 @@ T} T{
T} T{
(1L << 1)
T} T{
/\(** user specified width, height */
/\&* user specified width, height */
T}
T{
\&#define
......@@ -352,7 +352,7 @@ T} T{
T} T{
(1L << 2)
T} T{
/\(** program specified position */
/\&* program specified position */
T}
T{
\&#define
......@@ -361,7 +361,7 @@ T} T{
T} T{
(1L << 3)
T} T{
/\(** program specified size */
/\&* program specified size */
T}
T{
\&#define
......@@ -370,7 +370,7 @@ T} T{
T} T{
(1L << 4)
T} T{
/\(** program specified minimum size */
/\&* program specified minimum size */
T}
T{
\&#define
......@@ -379,7 +379,7 @@ T} T{
T} T{
(1L << 5)
T} T{
/\(** program specified maximum size */
/\&* program specified maximum size */
T}
T{
\&#define
......@@ -388,7 +388,7 @@ T} T{
T} T{
(1L << 6)
T} T{
/\(** program specified resize increments */
/\&* program specified resize increments */
T}
T{
\&#define
......@@ -397,7 +397,7 @@ T} T{
T} T{
(1L << 7)
T} T{
/\(** program specified min and max aspect ratios */
/\&* program specified min and max aspect ratios */
T}
T{
\&#define
......@@ -430,22 +430,22 @@ T}
.Ds 0
.TA .5i 2.5i
.ta .5i 2.5i
/\(** Values */
/\&* Values */
typedef struct {
long flags; /\(** marks which fields in this structure are defined */
int x, y; /\(** Obsolete */
int width, height; /\(** Obsolete */
long flags; /\&* marks which fields in this structure are defined */
int x, y; /\&* Obsolete */
int width, height; /\&* Obsolete */
int min_width, min_height;
int max_width, max_height;
int width_inc, height_inc;
struct {
int x; /\(** numerator */
int y; /\(** denominator */
int x; /\&* numerator */
int y; /\&* denominator */
} min_aspect, max_aspect;
int base_width, base_height;
int win_gravity;
/\(** this structure may be extended in the future */
/\&* this structure may be extended in the future */
} XSizeHints;
.De
.LP
......
......@@ -284,7 +284,7 @@ The
.ZN XStandardColormap
structure contains:
.LP
/\(** Hints */
/\&* Hints */
.TS
lw(.5i) lw(2i) lw(1i).
T{
......@@ -295,7 +295,7 @@ T} T{
( (XID) 1L)
T}
.TE
/\(** Values */
/\&* Values */
.IN "XStandardColormap" "" "@DEF@"
.Ds 0
.TA .5i 2.5i
......
......@@ -217,7 +217,7 @@ The
.ZN XWMHints
structure contains:
.LP
/\(** Window manager hints mask bits */
/\&* Window manager hints mask bits */
.TS
lw(.5i) lw(2.5i) lw(2.5i).
T{
......@@ -292,19 +292,19 @@ T}
.Ds 0
.TA .5i 2.5i
.ta .5i 2.5i
/\(** Values */
/\&* Values */
typedef struct {
long flags; /\(** marks which fields in this structure are defined */
Bool input; /\(** does this application rely on the window manager to
long flags; /\&* marks which fields in this structure are defined */
Bool input; /\&* does this application rely on the window manager to
get keyboard input? */
int initial_state; /\(** see below */
Pixmap icon_pixmap; /\(** pixmap to be used as icon */
Window icon_window; /\(** window to be used as icon */
int icon_x, icon_y; /\(** initial position of icon */
Pixmap icon_mask; /\(** pixmap to be used as mask for icon_pixmap */
XID window_group; /\(** id of related window group */
/\(** this structure may be extended in the future */
int initial_state; /\&* see below */
Pixmap icon_pixmap; /\&* pixmap to be used as icon */
Window icon_window; /\&* window to be used as icon */
int icon_x, icon_y; /\&* initial position of icon */
Pixmap icon_mask; /\&* pixmap to be used as mask for icon_pixmap */
XID window_group; /\&* id of related window group */
/\&* this structure may be extended in the future */
} XWMHints;
.De
.LP
......@@ -358,7 +358,7 @@ T} T{
T} T{
1
T} T{
/\(** most applications start this way */
/\&* most applications start this way */
T}
T{
\&#define
......@@ -367,7 +367,7 @@ T} T{
T} T{
3
T} T{
/\(** application wants to start as an icon */
/\&* application wants to start as an icon */
T}
.TE
The icon_mask specifies which pixels of the icon_pixmap should be used as the
......
......@@ -153,9 +153,9 @@ have the following common members:
.ta .5i 3i
typedef struct {
int type;
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window;
} XAnyEvent;
.De
......@@ -186,7 +186,7 @@ structure is a union of the individual structures declared for each event type:
.TA .5i 3i
.ta .5i 3i
typedef union _XEvent {
int type; /\(** must not be changed */
int type; /\&* must not be changed */
XAnyEvent xany;
XKeyEvent xkey;
XButtonEvent xbutton;
......
......@@ -158,19 +158,19 @@ events contain:
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\(** ButtonPress or ButtonRelease */
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
Window window; /\(** ``event'' window it is reported relative to */
Window root; /\(** root window that the event occurred on */
Window subwindow; /\(** child window */
Time time; /\(** milliseconds */
int x, y; /\(** pointer x, y coordinates in event window */
int x_root, y_root; /\(** coordinates relative to root */
unsigned int state; /\(** key or button mask */
unsigned int button; /\(** detail */
Bool same_screen; /\(** same screen flag */
int type; /\&* ButtonPress or ButtonRelease */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window; /\&* ``event'' window it is reported relative to */
Window root; /\&* root window that the event occurred on */
Window subwindow; /\&* child window */
Time time; /\&* milliseconds */
int x, y; /\&* pointer x, y coordinates in event window */
int x_root, y_root; /\&* coordinates relative to root */
unsigned int state; /\&* key or button mask */
unsigned int button; /\&* detail */
Bool same_screen; /\&* same screen flag */
} XButtonEvent;
typedef XButtonEvent XButtonPressedEvent;
typedef XButtonEvent XButtonReleasedEvent;
......@@ -180,19 +180,19 @@ typedef XButtonEvent XButtonReleasedEvent;
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\(** KeyPress or KeyRelease */
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
Window window; /\(** ``event'' window it is reported relative to */
Window root; /\(** root window that the event occurred on */
Window subwindow; /\(** child window */
Time time; /\(** milliseconds */
int x, y; /\(** pointer x, y coordinates in event window */
int x_root, y_root; /\(** coordinates relative to root */
unsigned int state; /\(** key or button mask */
unsigned int keycode; /\(** detail */
Bool same_screen; /\(** same screen flag */
int type; /\&* KeyPress or KeyRelease */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window; /\&* ``event'' window it is reported relative to */
Window root; /\&* root window that the event occurred on */
Window subwindow; /\&* child window */
Time time; /\&* milliseconds */
int x, y; /\&* pointer x, y coordinates in event window */
int x_root, y_root; /\&* coordinates relative to root */
unsigned int state; /\&* key or button mask */
unsigned int keycode; /\&* detail */
Bool same_screen; /\&* same screen flag */
} XKeyEvent;
typedef XKeyEvent XKeyPressedEvent;
typedef XKeyEvent XKeyReleasedEvent;
......@@ -202,19 +202,19 @@ typedef XKeyEvent XKeyReleasedEvent;
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\(** MotionNotify */
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
Window window; /\(** ``event'' window reported relative to */
Window root; /\(** root window that the event occurred on */
Window subwindow; /\(** child window */
Time time; /\(** milliseconds */
int x, y; /\(** pointer x, y coordinates in event window */
int x_root, y_root; /\(** coordinates relative to root */
unsigned int state; /\(** key or button mask */
char is_hint; /\(** detail */
Bool same_screen; /\(** same screen flag */
int type; /\&* MotionNotify */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window; /\&* ``event'' window reported relative to */
Window root; /\&* root window that the event occurred on */
Window subwindow; /\&* child window */
Time time; /\&* milliseconds */
int x, y; /\&* pointer x, y coordinates in event window */
int x_root, y_root; /\&* coordinates relative to root */
unsigned int state; /\&* key or button mask */
char is_hint; /\&* detail */
Bool same_screen; /\&* same screen flag */
} XMotionEvent;
typedef XMotionEvent XPointerMovedEvent;
.De
......
......@@ -251,7 +251,7 @@ The
structure contains:
.LP
.LP
/\(** Mask bits for ChangeKeyboardControl */
/\&* Mask bits for ChangeKeyboardControl */
.TS
lw(.5i) lw(2.5i) lw(.8i).
T{
......@@ -315,7 +315,7 @@ T}
.Ds 0
.TA .5i 2.5i
.ta .5i 2.5i
/\(** Values */
/\&* Values */
typedef struct {
int key_click_percent;
......@@ -323,9 +323,9 @@ typedef struct {
int bell_pitch;
int bell_duration;
int led;
int led_mode; /\(** LedModeOn, LedModeOff */
int led_mode; /\&* LedModeOn, LedModeOff */
int key;
int auto_repeat_mode; /\(** AutoRepeatModeOff, AutoRepeatModeOn,
int auto_repeat_mode; /\&* AutoRepeatModeOff, AutoRepeatModeOn,
AutoRepeatModeDefault */
} XKeyboardControl;
.De
......
......@@ -428,8 +428,8 @@ structure contains:
.TA .5i 2.5i
.ta .5i 2.5i
typedef struct {
int max_keypermod; /\(** This server's max number of keys per modifier */
KeyCode *modifiermap; /\(** An 8 by max_keypermod array of the modifiers */
int max_keypermod; /\&* This server's max number of keys per modifier */
KeyCode *modifiermap; /\&* An 8 by max_keypermod array of the modifiers */
} XModifierKeymap;
.De
.SH DIAGNOSTICS
......
......@@ -153,13 +153,13 @@ events contains:
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\(** CirculateNotify */
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
int type; /\&* CirculateNotify */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window event;
Window window;
int place; /\(** PlaceOnTop, PlaceOnBottom */
int place; /\&* PlaceOnTop, PlaceOnBottom */
} XCirculateEvent;
.De
.LP
......
......@@ -153,13 +153,13 @@ events contains:
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\(** CirculateRequest */
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
int type; /\&* CirculateRequest */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window parent;
Window window;
int place; /\(** PlaceOnTop, PlaceOnBottom */
int place; /\&* PlaceOnTop, PlaceOnBottom */
} XCirculateRequestEvent;
.De
.LP
......
......@@ -153,10 +153,10 @@ events contains:
.TA .5i 1i 3i
.ta .5i 1i 3i
typedef struct {
int type; /\(** ClientMessage */
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
int type; /\&* ClientMessage */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window;
Atom message_type;
int format;
......
......@@ -153,14 +153,14 @@ events contains:
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\(** ColormapNotify */
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
int type; /\&* ColormapNotify */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window;
Colormap colormap; /\(** colormap or None */
Colormap colormap; /\&* colormap or None */
Bool new;
int state; /\(** ColormapInstalled, ColormapUninstalled */
int state; /\&* ColormapInstalled, ColormapUninstalled */
} XColormapEvent;
.De
.LP
......
......@@ -153,10 +153,10 @@ events contains:
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\(** ConfigureNotify */
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
int type; /\&* ConfigureNotify */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window event;
Window window;
int x, y;
......
......@@ -153,17 +153,17 @@ events contains:
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\(** ConfigureRequest */
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
int type; /\&* ConfigureRequest */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window parent;
Window window;
int x, y;
int width, height;
int border_width;
Window above;
int detail; /\(** Above, Below, TopIf, BottomIf, Opposite */
int detail; /\&* Above, Below, TopIf, BottomIf, Opposite */
unsigned long value_mask;
} XConfigureRequestEvent;
.De
......
......@@ -334,7 +334,7 @@ The
structure contains:
.LP
.LP
/\(** Configure window value mask bits */
/\&* Configure window value mask bits */
.TS
lw(.5i) lw(2.5i) lw(.8i).
T{
......@@ -391,7 +391,7 @@ T}
.Ds 0
.TA .5i 3i
.ta .5i 3i
/\(** Values */
/\&* Values */
typedef struct {
int x, y;
......
......@@ -313,9 +313,9 @@ structure contains:
.TA .5i 2.5i
.ta .5i 2.5i
typedef struct {
unsigned long pixel; /\(** pixel value */
unsigned short red, green, blue; /\(** rgb values */
char flags; /\(** DoRed, DoGreen, DoBlue */
unsigned long pixel; /\&* pixel value */
unsigned short red, green, blue; /\&* rgb values */
char flags; /\&* DoRed, DoGreen, DoBlue */
char pad;
} XColor;
.De
......
......@@ -311,7 +311,7 @@ The
structure contains:
.LP
.LP
/\(** GC attribute value mask bits */
/\&* GC attribute value mask bits */
.TS
lw(.5i) lw(2.5i) lw(.75i).
T{
......@@ -480,31 +480,31 @@ T}
.Ds 0
.TA .5i 3i
.ta .5i 3i
/\(** Values */
/\&* Values */
typedef struct {
int function; /\(** logical operation */
unsigned long plane_mask; /\(** plane mask */
unsigned long foreground; /\(** foreground pixel */
unsigned long background; /\(** background pixel */
int line_width; /\(** line width (in pixels) */
int line_style; /\(** LineSolid, LineOnOffDash, LineDoubleDash */
int cap_style; /\(** CapNotLast, CapButt, CapRound, CapProjecting */
int join_style; /\(** JoinMiter, JoinRound, JoinBevel */
int fill_style; /\(** FillSolid, FillTiled, FillStippled FillOpaqueStippled*/
int fill_rule; /\(** EvenOddRule, WindingRule */
int arc_mode; /\(** ArcChord, ArcPieSlice */
Pixmap tile; /\(** tile pixmap for tiling operations */
Pixmap stipple; /\(** stipple 1 plane pixmap for stippling */
int ts_x_origin; /\(** offset for tile or stipple operations */
int function; /\&* logical operation */
unsigned long plane_mask; /\&* plane mask */
unsigned long foreground; /\&* foreground pixel */
unsigned long background; /\&* background pixel */
int line_width; /\&* line width (in pixels) */
int line_style; /\&* LineSolid, LineOnOffDash, LineDoubleDash */
int cap_style; /\&* CapNotLast, CapButt, CapRound, CapProjecting */
int join_style; /\&* JoinMiter, JoinRound, JoinBevel */
int fill_style; /\&* FillSolid, FillTiled, FillStippled FillOpaqueStippled*/
int fill_rule; /\&* EvenOddRule, WindingRule */
int arc_mode; /\&* ArcChord, ArcPieSlice */
Pixmap tile; /\&* tile pixmap for tiling operations */
Pixmap stipple; /\&* stipple 1 plane pixmap for stippling */
int ts_x_origin; /\&* offset for tile or stipple operations */
int ts_y_origin;
Font font; /\(** default text font for text operations */
int subwindow_mode; /\(** ClipByChildren, IncludeInferiors */
Bool graphics_exposures; /\(** boolean, should exposures be generated */
int clip_x_origin; /\(** origin for clipping */
Font font; /\&* default text font for text operations */
int subwindow_mode; /\&* ClipByChildren, IncludeInferiors */
Bool graphics_exposures; /\&* boolean, should exposures be generated */
int clip_x_origin; /\&* origin for clipping */
int clip_y_origin;
Pixmap clip_mask; /\(** bitmap clipping; other calls for rects */
int dash_offset; /\(** patterned/dashed line information */
Pixmap clip_mask; /\&* bitmap clipping; other calls for rects */
int dash_offset; /\&* patterned/dashed line information */
char dashes;
} XGCValues;
.De
......
......@@ -319,7 +319,7 @@ The
structure contains:
.LP
.LP
/\(** Window attribute value mask bits */
/\&* Window attribute value mask bits */
.TS
lw(.5i) lw(2.5i) lw(.8i).
T{
......@@ -432,24 +432,24 @@ T}
.Ds 0
.TA .5i 3i
.ta .5i 3i
/\(** Values */
/\&* Values */
typedef struct {
Pixmap background_pixmap; /\(** background, None, or ParentRelative */
unsigned long background_pixel; /\(** background pixel */
Pixmap border_pixmap; /\(** border of the window or CopyFromParent */
unsigned long border_pixel; /\(** border pixel value */
int bit_gravity; /\(** one of bit gravity values */
int win_gravity; /\(** one of the window gravity values */
int backing_store; /\(** NotUseful, WhenMapped, Always */
unsigned long backing_planes; /\(** planes to be preserved if possible */
unsigned long backing_pixel; /\(** value to use in restoring planes */
Bool save_under; /\(** should bits under be saved? (popups) */
long event_mask; /\(** set of events that should be saved */
long do_not_propagate_mask; /\(** set of events that should not propagate */
Bool override_redirect; /\(** boolean value for override_redirect */
Colormap colormap; /\(** color map to be associated with window */
Cursor cursor; /\(** cursor to be displayed (or None) */
Pixmap background_pixmap; /\&* background, None, or ParentRelative */
unsigned long background_pixel; /\&* background pixel */
Pixmap border_pixmap; /\&* border of the window or CopyFromParent */
unsigned long border_pixel; /\&* border pixel value */
int bit_gravity; /\&* one of bit gravity values */
int win_gravity; /\&* one of the window gravity values */
int backing_store; /\&* NotUseful, WhenMapped, Always */
unsigned long backing_planes; /\&* planes to be preserved if possible */
unsigned long backing_pixel; /\&* value to use in restoring planes */
Bool save_under; /\&* should bits under be saved? (popups) */
long event_mask; /\&* set of events that should be saved */
long do_not_propagate_mask; /\&* set of events that should not propagate */
Bool override_redirect; /\&* boolean value for override_redirect */
Colormap colormap; /\&* color map to be associated with window */
Cursor cursor; /\&* cursor to be displayed (or None) */
} XSetWindowAttributes;
.De
.LP
......
......@@ -153,16 +153,16 @@ events contains:
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\(** CreateNotify */
unsigned long serial; /\(** # of last request processed by server */
Bool send_event; /\(** true if this came from a SendEvent request */
Display *display; /\(** Display the event was read from */
Window parent; /\(** parent of the window */
Window window; /\(** window id of window created */
int x, y; /\(** window location */
int width, height; /\(** size of window */
int border_width; /\(** border width */
Bool override_redirect; /\(** creation should be overridden */
int type; /\&* CreateNotify */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window parent; /\&* parent of the window */
Window window; /\&* window id of window created */
int x, y; /\&* window location */
int width, height; /\&* size of window */
int border_width; /\&* border width */
Bool override_redirect; /\&* creation should be overridden */
} XCreateWindowEvent;
.De
.LP
......
......@@ -155,25 +155,25 @@ events contains:
.TA .5i 3i
.ta .5i 3i