Commit 4f4f2973 authored by Glenn Morris's avatar Glenn Morris
Browse files

Sync docs of some X, W32, NS C functions.

* src/nsfns.m (Fx-display-save-under, Fx-open-connection)
(Fxw-color-defined-p, Fxw-display-color-p, Fx-show-tip):
* src/w32fns.c (Fxw_color_defined_p, Fx_open_connection):
* src/xfns.c (Fxw_color_defined_p, Fx_open_connection):
Sync docs between X, W32, NS.
parent e088c02a
2010-10-29 Glenn Morris <rgm@gnu.org>
 
* nsfns.m (Fx-display-save-under, Fx-open-connection)
(Fxw-color-defined-p, Fxw-display-color-p, Fx-show-tip):
* w32fns.c (Fxw_color_defined_p, Fx_open_connection):
* xfns.c (Fxw_color_defined_p, Fx_open_connection):
Sync docs between X, W32, NS.
* buffer.c (syms_of_buffer) <abbrev-mode, transient-mark-mode>:
* frame.c (syms_of_frame) <tool-bar-mode>: Move doc here from Lisp.
 
......
/* Functions for the NeXT/Open/GNUstep and MacOSX window system.
Copyright (C) 1989, 1992, 1993, 1994, 2005, 2006, 2008, 2009, 2010
Free Software Foundation, Inc.
Copyright (C) 1989, 1992, 1993, 1994, 2005, 2006, 2008, 2009, 2010
Free Software Foundation, Inc.
This file is part of GNU Emacs.
......@@ -1697,7 +1698,7 @@ and GNUstep implementations ("distributor-specific release
DEFUN ("x-display-save-under", Fx_display_save_under,
Sx_display_save_under, 0, 1, 0,
doc: /* Non-nil if the Nextstep display server supports the save-under feature.
doc: /* Return t if DISPLAY supports the save-under feature.
The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be a frame, the display name as a string, or a terminal ID.
If omitted or nil, the selected frame's display is used. */)
......@@ -1722,9 +1723,12 @@ and GNUstep implementations ("distributor-specific release
DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
1, 3, 0,
doc: /* Open a connection to a Nextstep display server.
doc: /* Open a connection to a display server.
DISPLAY is the name of the display to connect to.
Optional arguments XRM-STRING and MUST-SUCCEED are currently ignored. */)
Optional second arg XRM-STRING is a string of resources in xrdb format.
If the optional third arg MUST-SUCCEED is non-nil,
terminate Emacs if we can't open the connection.
\(In the Nextstep version, the last two arguments are currently ignored.) */)
(Lisp_Object display, Lisp_Object resource_string, Lisp_Object must_succeed)
{
struct ns_display_info *dpyinfo;
......@@ -2201,8 +2205,8 @@ and GNUstep implementations ("distributor-specific release
DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
doc: /* Return t if the current Nextstep display supports the color COLOR.
The optional argument FRAME is currently ignored. */)
doc: /* Internal function called by `color-defined-p', which see.
\(Note that the Nextstep version of this function ignores FRAME.) */)
(Lisp_Object color, Lisp_Object frame)
{
NSColor * col;
......@@ -2233,10 +2237,7 @@ and GNUstep implementations ("distributor-specific release
DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
doc: /* Return t if the Nextstep display supports color.
The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame, a display name (a string), or terminal ID.
If omitted or nil, that stands for the selected frame's display. */)
doc: /* Internal function called by `display-color-p', which see. */)
(Lisp_Object display)
{
NSWindowDepth depth;
......@@ -2430,6 +2431,8 @@ The return value is a list of integers (LEFT TOP WIDTH HEIGHT), which
doc: /* Show STRING in a \"tooltip\" window on frame FRAME.
A tooltip window is a small window displaying a string.
This is an internal function; Lisp code should call `tooltip-show'.
FRAME nil or omitted means use the selected frame.
PARMS is an optional list of frame parameters which can be used to
......@@ -2675,4 +2678,3 @@ - (NSString *)panel: (id)sender userEnteredFilename: (NSString *)filename
}
// arch-tag: dc2a3f74-1123-4daa-8eed-fb78db6a5642
......@@ -4511,7 +4511,8 @@ DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
doc: /* Internal function called by `color-defined-p', which see. */)
doc: /* Internal function called by `color-defined-p', which see.
\(Note that the Nextstep version of this function ignores FRAME.) */)
(Lisp_Object color, Lisp_Object frame)
{
XColor foo;
......@@ -4851,11 +4852,12 @@ x_display_info_for_name (Lisp_Object name)
}
DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
1, 3, 0, doc: /* Open a connection to a server.
1, 3, 0, doc: /* Open a connection to a display server.
DISPLAY is the name of the display to connect to.
Optional second arg XRM-STRING is a string of resources in xrdb format.
If the optional third arg MUST-SUCCEED is non-nil,
terminate Emacs if we can't open the connection. */)
terminate Emacs if we can't open the connection.
\(In the Nextstep version, the last two arguments are currently ignored.) */)
(Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
{
unsigned char *xrm_option;
......@@ -7267,5 +7269,3 @@ w32_last_error (void)
return GetLastError ();
}
/* arch-tag: 707589ab-b9be-4638-8cdd-74629cc9b446
(do not change this comment) */
......@@ -3581,7 +3581,8 @@ FRAME nil means use the selected frame. */)
DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
doc: /* Internal function called by `color-defined-p', which see. */)
doc: /* Internal function called by `color-defined-p', which see
.\(Note that the Nextstep version of this function ignores FRAME.) */)
(Lisp_Object color, Lisp_Object frame)
{
XColor foo;
......@@ -4099,11 +4100,12 @@ x_display_info_for_name (Lisp_Object name)
DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
1, 3, 0,
doc: /* Open a connection to an X server.
doc: /* Open a connection to a display server.
DISPLAY is the name of the display to connect to.
Optional second arg XRM-STRING is a string of resources in xrdb format.
If the optional third arg MUST-SUCCEED is non-nil,
terminate Emacs if we can't open the connection. */)
terminate Emacs if we can't open the connection.
\(In the Nextstep version, the last two arguments are currently ignored.) */)
(Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
{
unsigned char *xrm_option;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment