]> git.eshelyaron.com Git - emacs.git/commitdiff
Add a doc string to redisplay-highlight-region-function
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 27 Jul 2019 13:59:32 +0000 (15:59 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sat, 27 Jul 2019 14:25:45 +0000 (16:25 +0200)
* lisp/simple.el (redisplay-highlight-region-function): Add a doc
string (bug#24701).

lisp/simple.el

index 742d6cb6ff394044dacbe0c99d542d5514267cdc..2c6fc84e73fc5465c1f7f43e7e0c8b26f128ce7b 100644 (file)
@@ -5614,6 +5614,13 @@ separate contiguous regions for each line."
   (lambda (rol) (when (overlayp rol) (delete-overlay rol))))
 
 (defvar redisplay-highlight-region-function
+  "Function to move the highlight overlay.
+This function is called with four parameters, START, END, WINDOW
+and OVERLAY.  If OVERLAY is nil, a new overlay is created.  In
+any case, the overlay is adjusted to reflect the other three
+parameters.
+
+The overlay is returned by the function."
   (lambda (start end window rol)
     (if (not (overlayp rol))
         (let ((nrol (make-overlay start end)))