1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-23 10:34:07 +00:00

(follow-windows-aligned-p): Doc fix.

(follow-post-command-hook, follow-recenter): Doc fix.
(follow-end-of-buffer, follow-windows-aligned-p): Doc fix.
(follow-post-command-hook, follow-maximize-region): Doc fix.
(set-process-filter, process-filter, move-overlay): Advice doc fix.
This commit is contained in:
Karl Heuer 1997-06-03 07:09:13 +00:00
parent 6824710a86
commit cb02be17ba

View File

@ -1,6 +1,6 @@
;;; follow.el --- Minor mode, Synchronize windows showing the same buffer.
;; Copyright (C) 1995, 1996 Free Software Foundation, Inc.
;; Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
;; Author: Anders Lindgren <andersl@csd.uu.se>
;; Maintainer: Anders Lindgren <andersl@csd.uu.se>
@ -279,7 +279,7 @@
;; * submit-feedback.
;; * Survives major mode changes.
;; * Region spanning multiple windows looks
;; resonabely good.
;; reasonably good.
;; 19-Jul-95 andersl * New process-filter handling.
;; 1-Aug-95 andersl * XEmacs scrollbar support.
;; * Emacs 19 `window-size-change' support.
@ -499,7 +499,7 @@ Used by `follow-window-size-change'.")
;; This inline function must be as small as possible!
;; Maybe we should define a macro which expands to nil if
;; the varible is not set.
;; the variable is not set.
(defsubst follow-debug-message (&rest args)
"Like message, but only active when `follow-debug' is non-nil."
@ -994,8 +994,8 @@ in your `~/.emacs' file:
;;{{{ Redraw
(defun follow-recenter (&optional arg)
"Recenter the middle window around the point,
and rearrange all other windows around the middle window.
"Recenter the middle window around point.
Rearrange all other windows around the middle window.
With a positive argument, place the current line ARG lines
from the top. With a negative, place it -ARG lines from the
@ -1042,7 +1042,7 @@ Follow mode since the windows should always be aligned."
;;{{{ End of buffer
(defun follow-end-of-buffer (&optional arg)
"Move point to the end of the buffer. Follow Mode style.
"Move point to the end of the buffer, Follow Mode style.
If the end is not visible, it will be displayed in the last possible
window in the Follow Mode window chain.
@ -1228,7 +1228,7 @@ Note that this handles the case when the cache has been set to nil."
;; should start at a full screen line.
(defsubst follow-windows-aligned-p (win-start-end)
"Non-nil if the follower WINDOWS are alinged."
"Non-nil if the follower WINDOWS are aligned."
(let ((res t))
(save-excursion
(goto-char (window-start (car (car win-start-end))))
@ -1310,7 +1310,7 @@ Return the selected window."
;;
;; (Compability cludge: in Emacs 19 `window-end' is equal to `point-max';
;; in XEmacs, it is equal to `point-max + 1'. Should I really bother
;; checking `window-end' now when I check `end-of-buffer' explicitylt?)
;; checking `window-end' now when I check `end-of-buffer' explicitly?)
(defun follow-select-if-end-visible (win-start-end)
"Select and return a window, if end is visible in it."
@ -1602,7 +1602,7 @@ non-first windows in Follow Mode."
;; in several window even though they are aligned.
(defun follow-post-command-hook ()
"Ensure that the windows in Follow mode are adjecent after each command."
"Ensure that the windows in Follow mode are adjacent after each command."
(setq follow-inside-post-command-hook t)
(if (or (not (input-pending-p))
;; Sometimes, in XEmacs, mouse events are not handled
@ -1793,12 +1793,11 @@ non-first windows in Follow Mode."
;; good when spanning several windows.
;;
;; Not perfect, as the point can't be placed at window end, only at
;; end-1. Whis will highlight a little bit in windows above
;; end-1. This will highlight a little bit in windows above
;; the current.
(defun follow-maximize-region (win windows win-start-end)
"Make a highlighted region stretching multiple windows look good
when in Follow mode."
"Make a highlighted region stretching multiple windows look good."
(let* ((all (follow-split-followers windows win))
(pred (car all))
(succ (cdr all))
@ -1949,7 +1948,7 @@ WINDOW can be an object or a window."
;;; output filter. It also makes sure that the windows connected to
;;; the buffer are aligned.
;;;
;;; Discussion: How to we find processes which doesn't call
;;; Discussion: How do we find processes which don't call
;;; `set-process-filter'? (How often are processes created in a
;;; buffer after Follow mode are activated?)
;;;
@ -1962,9 +1961,7 @@ WINDOW can be an object or a window."
;; filter...
(defadvice set-process-filter (before follow-set-process-filter activate)
"Follow Mode listens to calls to this function to make
sure process output will be displayed correctly in buffers
in which the mode is activated.
"Ensure process output will be displayed correctly in Follow Mode buffers."
Follow Mode inserts its own process filter to do its
magic stuff before the real process filter is called."
@ -1997,9 +1994,7 @@ magic stuff before the real process filter is called."
(defadvice process-filter (after follow-process-filter activate)
"Normally when Follow mode is activated all processes has the
process filter set to `follow-generic-filter'. With this advice,
the original process filter is returned."
"Return the original process filter, not `follow-generic-filter'."
(cond ((eq ad-return-value 'follow-generic-filter)
(setq ad-return-value
(cdr-safe (assq (ad-get-arg 0)
@ -2369,9 +2364,9 @@ displaying a short file in two windows, using Follow Mode."
(if (and follow-avoid-tail-recenter-p
(fboundp 'move-overlay))
(defadvice move-overlay (before follow-move-overlay activate)
"Adviced by Follow Mode. Don't recenter windows showing only
the end of a buffer. This prevents `mouse-drag-region' from
messing things up."
"Adviced by Follow Mode.
Don't recenter windows showing only the end of a buffer.
This prevents `mouse-drag-region' from messing things up."
(follow-avoid-tail-recenter)))
;;}}}