# HG changeset patch
# User stephent
# Date 1156860654 0
# Node ID 91950589598c94c962ff379d075e3f7a6d8865a9
# Parent  ff0dac582fcbef0f1e09a554fe79ea3ab109e2da
[xemacs-hg @ 2006-08-29 14:10:51 by stephent]
Some docstring improvements. <87irkbk5ad.fsf@tleepslib.sk.tsukuba.ac.jp>

diff -r ff0dac582fcb -r 91950589598c src/ChangeLog
--- a/src/ChangeLog	Mon Aug 28 21:51:04 2006 +0000
+++ b/src/ChangeLog	Tue Aug 29 14:10:54 2006 +0000
@@ -1,3 +1,13 @@
+2006-08-29  Stephen J. Turnbull  <stephen@xemacs.org>
+
+	* eval.c (Fcatch): Correct syntax of `throw' in docstring.
+
+	* cmds.c (Fforward_line): Document that return can be negative.
+
+2006-08-11  Stephen J. Turnbull  <stephen@xemacs.org>
+
+	* frame.c (mouse-motion-handler): Document relation to hooks.
+
 2006-08-24  Aidan Kehoe  <kehoea@parhasard.net>
 
 	* console-tty-impl.h (struct tty_console):
diff -r ff0dac582fcb -r 91950589598c src/cmds.c
--- a/src/cmds.c	Mon Aug 28 21:51:04 2006 +0000
+++ b/src/cmds.c	Tue Aug 29 14:10:54 2006 +0000
@@ -126,6 +126,7 @@
 If there isn't room, go as far as possible (no error).
 Returns the count of lines left to move.  If moving forward,
 that is COUNT - number of lines moved; if backward, COUNT + number moved.
+\(Note that if COUNT is negative, the return will be non-positive.)
 With positive COUNT, a non-empty line at the end counts as one line
   successfully moved (for the return value).
 If BUFFER is nil, the current buffer is assumed.
diff -r ff0dac582fcb -r 91950589598c src/eval.c
--- a/src/eval.c	Mon Aug 28 21:51:04 2006 +0000
+++ b/src/eval.c	Tue Aug 29 14:10:54 2006 +0000
@@ -1472,7 +1472,7 @@
 DEFUN ("catch", Fcatch, 1, UNEVALLED, 0, /*
 \(catch TAG BODY...): eval BODY allowing nonlocal exits using `throw'.
 TAG is evalled to get the tag to use.  Then the BODY is executed.
-Within BODY, (throw TAG) with same (`eq') tag exits BODY and this `catch'.
+Within BODY, (throw TAG VAL) with same (`eq') tag exits BODY and this `catch'.
 If no throw happens, `catch' returns the value of the last BODY form.
 If a throw happens, it specifies the value to return from `catch'.
 */
diff -r ff0dac582fcb -r 91950589598c src/frame.c
--- a/src/frame.c	Mon Aug 28 21:51:04 2006 +0000
+++ b/src/frame.c	Tue Aug 29 14:10:54 2006 +0000
@@ -3838,8 +3838,17 @@
   Vadjust_frame_function = Qnil;
 
   DEFVAR_LISP ("mouse-motion-handler", &Vmouse_motion_handler /*
-Handler for motion events.  One arg, the event.
+Handler for motion events.  Must be a function taking one argument, the event.
 For most applications, you should use `mode-motion-hook' instead of this.
+The default value is `default-mouse-motion-handler'.
+
+Note that this is NOT a hook variable, so there is no standard way to remove
+actions from it.  Instead, when adding a new kind of action, a hook variable
+should be defined and initialized to the current value of this variable, then
+this variable set to a function that runs the new hook.  To disable the new
+actions, use `remove-hook' rather than setting `mouse-motion-handler'.
+
+`mouse-motion-hook' in the balloon-help library exemplifies this pattern.
 */ );
   Vmouse_motion_handler = Qnil;