# HG changeset patch # User John Paul Wallington # Date 1137920152 0 # Node ID ea3b2a2d848c244d58e2751b1a3b1f4b40be72d6 # Parent a9f17642be15b8a0420e9cfa6a776ee3df654d74 (hl-line-highlight, hl-line-move): Doc fixes. diff -r a9f17642be15 -r ea3b2a2d848c lisp/hl-line.el --- a/lisp/hl-line.el Sun Jan 22 08:27:00 2006 +0000 +++ b/lisp/hl-line.el Sun Jan 22 08:55:52 2006 +0000 @@ -1,7 +1,7 @@ ;;; hl-line.el --- highlight the current line ;; Copyright (C) 1998, 2000, 2001, 2002, 2003, 2004, -;; 2005 Free Software Foundation, Inc. +;; 2005, 2006 Free Software Foundation, Inc. ;; Author: Dave Love ;; Maintainer: FSF @@ -58,7 +58,7 @@ ;; it to nil to avoid highlighting specific buffers, when the global ;; mode is used. -;; In default whole the line is highlighted. The range of highlighting +;; By default the whole line is highlighted. The range of highlighting ;; can be changed by defining an appropriate function as the ;; buffer-local value of `hl-line-range-function'. @@ -130,7 +130,7 @@ (remove-hook 'pre-command-hook #'hl-line-unhighlight t))) (defun hl-line-highlight () - "Active the Hl-Line overlay on the current line." + "Activate the Hl-Line overlay on the current line." (if hl-line-mode ; Might be changed outside the mode function. (progn (unless hl-line-overlay @@ -179,9 +179,9 @@ (delete-overlay global-hl-line-overlay))) (defun hl-line-move (overlay) - "Move the hl-line-mode overlay. + "Move the Hl-Line overlay. If `hl-line-range-function' is non-nil, move the OVERLAY to the position -where the function returns. If `hl-line-range-function' is nil, fill +where the function returns. If `hl-line-range-function' is nil, fill the line including the point by OVERLAY." (let (tmp b e) (if hl-line-range-function