aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGlenn Morris2010-10-29 00:04:09 -0700
committerGlenn Morris2010-10-29 00:04:09 -0700
commit4f4f2973e5229b984da408bb74e2a9a78f6d4051 (patch)
tree78f6eb3eaa9c4336a1f0108d8909f503e53aa9ec
parente088c02a81d502ef52cb494d6b73238b94861e3a (diff)
downloademacs-4f4f2973e5229b984da408bb74e2a9a78f6d4051.tar.gz
emacs-4f4f2973e5229b984da408bb74e2a9a78f6d4051.zip
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.
-rw-r--r--src/ChangeLog6
-rw-r--r--src/nsfns.m26
-rw-r--r--src/w32fns.c10
-rw-r--r--src/xfns.c8
4 files changed, 30 insertions, 20 deletions
diff --git a/src/ChangeLog b/src/ChangeLog
index d61e20aa600..c56e38dbe60 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,5 +1,11 @@
12010-10-29 Glenn Morris <rgm@gnu.org> 12010-10-29 Glenn Morris <rgm@gnu.org>
2 2
3 * nsfns.m (Fx-display-save-under, Fx-open-connection)
4 (Fxw-color-defined-p, Fxw-display-color-p, Fx-show-tip):
5 * w32fns.c (Fxw_color_defined_p, Fx_open_connection):
6 * xfns.c (Fxw_color_defined_p, Fx_open_connection):
7 Sync docs between X, W32, NS.
8
3 * buffer.c (syms_of_buffer) <abbrev-mode, transient-mark-mode>: 9 * buffer.c (syms_of_buffer) <abbrev-mode, transient-mark-mode>:
4 * frame.c (syms_of_frame) <tool-bar-mode>: Move doc here from Lisp. 10 * frame.c (syms_of_frame) <tool-bar-mode>: Move doc here from Lisp.
5 11
diff --git a/src/nsfns.m b/src/nsfns.m
index db8bbeb5f76..147f9aab801 100644
--- a/src/nsfns.m
+++ b/src/nsfns.m
@@ -1,6 +1,7 @@
1/* Functions for the NeXT/Open/GNUstep and MacOSX window system. 1/* Functions for the NeXT/Open/GNUstep and MacOSX window system.
2 Copyright (C) 1989, 1992, 1993, 1994, 2005, 2006, 2008, 2009, 2010 2
3 Free Software Foundation, Inc. 3Copyright (C) 1989, 1992, 1993, 1994, 2005, 2006, 2008, 2009, 2010
4 Free Software Foundation, Inc.
4 5
5This file is part of GNU Emacs. 6This file is part of GNU Emacs.
6 7
@@ -1697,7 +1698,7 @@ If omitted or nil, the selected frame's display is used. */)
1697 1698
1698DEFUN ("x-display-save-under", Fx_display_save_under, 1699DEFUN ("x-display-save-under", Fx_display_save_under,
1699 Sx_display_save_under, 0, 1, 0, 1700 Sx_display_save_under, 0, 1, 0,
1700 doc: /* Non-nil if the Nextstep display server supports the save-under feature. 1701 doc: /* Return t if DISPLAY supports the save-under feature.
1701The optional argument DISPLAY specifies which display to ask about. 1702The optional argument DISPLAY specifies which display to ask about.
1702DISPLAY should be a frame, the display name as a string, or a terminal ID. 1703DISPLAY should be a frame, the display name as a string, or a terminal ID.
1703If omitted or nil, the selected frame's display is used. */) 1704If omitted or nil, the selected frame's display is used. */)
@@ -1722,9 +1723,12 @@ If omitted or nil, the selected frame's display is used. */)
1722 1723
1723DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection, 1724DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
1724 1, 3, 0, 1725 1, 3, 0,
1725 doc: /* Open a connection to a Nextstep display server. 1726 doc: /* Open a connection to a display server.
1726DISPLAY is the name of the display to connect to. 1727DISPLAY is the name of the display to connect to.
1727Optional arguments XRM-STRING and MUST-SUCCEED are currently ignored. */) 1728Optional second arg XRM-STRING is a string of resources in xrdb format.
1729If the optional third arg MUST-SUCCEED is non-nil,
1730terminate Emacs if we can't open the connection.
1731\(In the Nextstep version, the last two arguments are currently ignored.) */)
1728 (Lisp_Object display, Lisp_Object resource_string, Lisp_Object must_succeed) 1732 (Lisp_Object display, Lisp_Object resource_string, Lisp_Object must_succeed)
1729{ 1733{
1730 struct ns_display_info *dpyinfo; 1734 struct ns_display_info *dpyinfo;
@@ -2201,8 +2205,8 @@ x_sync (struct frame *f)
2201 2205
2202 2206
2203DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0, 2207DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
2204 doc: /* Return t if the current Nextstep display supports the color COLOR. 2208 doc: /* Internal function called by `color-defined-p', which see.
2205The optional argument FRAME is currently ignored. */) 2209\(Note that the Nextstep version of this function ignores FRAME.) */)
2206 (Lisp_Object color, Lisp_Object frame) 2210 (Lisp_Object color, Lisp_Object frame)
2207{ 2211{
2208 NSColor * col; 2212 NSColor * col;
@@ -2233,10 +2237,7 @@ DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
2233 2237
2234 2238
2235DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0, 2239DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
2236 doc: /* Return t if the Nextstep display supports color. 2240 doc: /* Internal function called by `display-color-p', which see. */)
2237The optional argument DISPLAY specifies which display to ask about.
2238DISPLAY should be either a frame, a display name (a string), or terminal ID.
2239If omitted or nil, that stands for the selected frame's display. */)
2240 (Lisp_Object display) 2241 (Lisp_Object display)
2241{ 2242{
2242 NSWindowDepth depth; 2243 NSWindowDepth depth;
@@ -2430,6 +2431,8 @@ DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
2430 doc: /* Show STRING in a \"tooltip\" window on frame FRAME. 2431 doc: /* Show STRING in a \"tooltip\" window on frame FRAME.
2431A tooltip window is a small window displaying a string. 2432A tooltip window is a small window displaying a string.
2432 2433
2434This is an internal function; Lisp code should call `tooltip-show'.
2435
2433FRAME nil or omitted means use the selected frame. 2436FRAME nil or omitted means use the selected frame.
2434 2437
2435PARMS is an optional list of frame parameters which can be used to 2438PARMS is an optional list of frame parameters which can be used to
@@ -2675,4 +2678,3 @@ be used as the image of the icon representing the frame. */);
2675 2678
2676} 2679}
2677 2680
2678// arch-tag: dc2a3f74-1123-4daa-8eed-fb78db6a5642
diff --git a/src/w32fns.c b/src/w32fns.c
index 1612182c660..15dbb404737 100644
--- a/src/w32fns.c
+++ b/src/w32fns.c
@@ -4511,7 +4511,8 @@ DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
4511 4511
4512 4512
4513DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0, 4513DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4514 doc: /* Internal function called by `color-defined-p', which see. */) 4514 doc: /* Internal function called by `color-defined-p', which see.
4515\(Note that the Nextstep version of this function ignores FRAME.) */)
4515 (Lisp_Object color, Lisp_Object frame) 4516 (Lisp_Object color, Lisp_Object frame)
4516{ 4517{
4517 XColor foo; 4518 XColor foo;
@@ -4851,11 +4852,12 @@ x_display_info_for_name (Lisp_Object name)
4851} 4852}
4852 4853
4853DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection, 4854DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4854 1, 3, 0, doc: /* Open a connection to a server. 4855 1, 3, 0, doc: /* Open a connection to a display server.
4855DISPLAY is the name of the display to connect to. 4856DISPLAY is the name of the display to connect to.
4856Optional second arg XRM-STRING is a string of resources in xrdb format. 4857Optional second arg XRM-STRING is a string of resources in xrdb format.
4857If the optional third arg MUST-SUCCEED is non-nil, 4858If the optional third arg MUST-SUCCEED is non-nil,
4858terminate Emacs if we can't open the connection. */) 4859terminate Emacs if we can't open the connection.
4860\(In the Nextstep version, the last two arguments are currently ignored.) */)
4859 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed) 4861 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
4860{ 4862{
4861 unsigned char *xrm_option; 4863 unsigned char *xrm_option;
@@ -7267,5 +7269,3 @@ w32_last_error (void)
7267 return GetLastError (); 7269 return GetLastError ();
7268} 7270}
7269 7271
7270/* arch-tag: 707589ab-b9be-4638-8cdd-74629cc9b446
7271 (do not change this comment) */
diff --git a/src/xfns.c b/src/xfns.c
index 9958e6607e5..6492bbd8a23 100644
--- a/src/xfns.c
+++ b/src/xfns.c
@@ -3581,7 +3581,8 @@ FRAME nil means use the selected frame. */)
3581 3581
3582 3582
3583DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0, 3583DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3584 doc: /* Internal function called by `color-defined-p', which see. */) 3584 doc: /* Internal function called by `color-defined-p', which see
3585.\(Note that the Nextstep version of this function ignores FRAME.) */)
3585 (Lisp_Object color, Lisp_Object frame) 3586 (Lisp_Object color, Lisp_Object frame)
3586{ 3587{
3587 XColor foo; 3588 XColor foo;
@@ -4099,11 +4100,12 @@ x_display_info_for_name (Lisp_Object name)
4099 4100
4100DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection, 4101DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4101 1, 3, 0, 4102 1, 3, 0,
4102 doc: /* Open a connection to an X server. 4103 doc: /* Open a connection to a display server.
4103DISPLAY is the name of the display to connect to. 4104DISPLAY is the name of the display to connect to.
4104Optional second arg XRM-STRING is a string of resources in xrdb format. 4105Optional second arg XRM-STRING is a string of resources in xrdb format.
4105If the optional third arg MUST-SUCCEED is non-nil, 4106If the optional third arg MUST-SUCCEED is non-nil,
4106terminate Emacs if we can't open the connection. */) 4107terminate Emacs if we can't open the connection.
4108\(In the Nextstep version, the last two arguments are currently ignored.) */)
4107 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed) 4109 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
4108{ 4110{
4109 unsigned char *xrm_option; 4111 unsigned char *xrm_option;