From: Po Lu <luangruo@yahoo.com>
Date: Tue, 14 Jun 2022 11:49:58 +0000 (+0800)
Subject: ; Improve doc of `x-dnd-native-test-function'
X-Git-Tag: emacs-29.0.90~1910^2~14
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8fa1cdc1faf901f45554e97843efd1f01adc2e92;p=emacs.git

; Improve doc of `x-dnd-native-test-function'

* src/xterm.c (syms_of_xterm): Improve doc.  Suggested by Eli
Zaretskii <eliz@gnu.org>.
---

diff --git a/src/xterm.c b/src/xterm.c
index 333520c8bc5..2cc17b455da 100644
--- a/src/xterm.c
+++ b/src/xterm.c
@@ -27365,13 +27365,15 @@ argument to `x-begin-drag'.  */);
   Vx_dnd_targets_list = Qnil;
 
   DEFVAR_LISP ("x-dnd-native-test-function", Vx_dnd_native_test_function,
-    doc: /* Function called to determine return when dropping on Emacs itself.
-It should accept two arguments POS and ACTION, and return a symbol
-describing what to return from `x-begin-drag'.  POS is a mouse
-position list detailing the location of the drop, and ACTION is the
-action specified by the caller of `x-begin-drag'.
-
-If nil or a non-symbol value is returned, the drop will be
-cancelled.  */);
+    doc: /* Function that determines return value of drag-and-drop on Emacs frames.
+If the value is a function, `x-begin-drag' will call it with two
+arguments, POS and ACTION, where POS is a mouse position list
+that specifies the location of the drop, and ACTION is the
+action specified by the caller of `x-begin-drag'.  The function
+should return a symbol describing what to return from
+`x-begin-drag' if the drop happens on an Emacs frame.
+
+If the value is nil, or the function returns a value that is not
+a symbol, a drop on an Emacs frame will be canceled.  */);
   Vx_dnd_native_test_function = Qnil;
 }