diff options
| author | Juanma Barranquero | 2005-07-21 11:09:11 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2005-07-21 11:09:11 +0000 |
| commit | 5a7383fda0ef1787513d94095bee45104d515e26 (patch) | |
| tree | 3d039d512cab03a575687b4da8a2bff4ae09a73a | |
| parent | 551ea1bdb96496b1ca5aaf138c766fd970ea6620 (diff) | |
| download | emacs-5a7383fda0ef1787513d94095bee45104d515e26.tar.gz emacs-5a7383fda0ef1787513d94095bee45104d515e26.zip | |
(vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings,
vcursor-use-vcursor-map, vcursor-find-window, vcursor-scroll-down,
vcursor-disable, vcursor-beginning-of-buffer, vcursor-end-of-buffer):
Fix typos in docstrings.
(vcursor-relative-move, vcursor-get-char-count): Improve argument/docstring
consistency.
| -rw-r--r-- | lisp/vcursor.el | 39 |
1 files changed, 19 insertions, 20 deletions
diff --git a/lisp/vcursor.el b/lisp/vcursor.el index fd7d1416661..89f30cf7232 100644 --- a/lisp/vcursor.el +++ b/lisp/vcursor.el | |||
| @@ -356,7 +356,7 @@ disable the vcursor." | |||
| 356 | 356 | ||
| 357 | (defun vcursor-bind-keys (var value) | 357 | (defun vcursor-bind-keys (var value) |
| 358 | "Alter the value of the variable VAR to VALUE, binding keys as required. | 358 | "Alter the value of the variable VAR to VALUE, binding keys as required. |
| 359 | VAR is usually vcursor-key-bindings. Normally this function is called | 359 | VAR is usually `vcursor-key-bindings'. Normally this function is called |
| 360 | on loading vcursor and from the customize package." | 360 | on loading vcursor and from the customize package." |
| 361 | (set var value) | 361 | (set var value) |
| 362 | (cond | 362 | (cond |
| @@ -464,8 +464,8 @@ on loading vcursor and from the customize package." | |||
| 464 | 464 | ||
| 465 | (defcustom vcursor-key-bindings nil | 465 | (defcustom vcursor-key-bindings nil |
| 466 | "*How to bind keys when vcursor is loaded. | 466 | "*How to bind keys when vcursor is loaded. |
| 467 | If t, guess; if xterm, use bindings suitable for an X terminal; if | 467 | If t, guess; if `xterm', use bindings suitable for an X terminal; if |
| 468 | oemacs, use bindings which work on a PC with Oemacs. If nil, don't | 468 | `oemacs', use bindings which work on a PC with Oemacs. If nil, don't |
| 469 | define any key bindings. | 469 | define any key bindings. |
| 470 | 470 | ||
| 471 | Default is nil." | 471 | Default is nil." |
| @@ -514,7 +514,7 @@ scrolling set this. It is used by the `vcursor-auto-disable' code.") | |||
| 514 | 514 | ||
| 515 | (defvar vcursor-use-vcursor-map nil | 515 | (defvar vcursor-use-vcursor-map nil |
| 516 | "Non-nil if the vcursor map is mapped directly onto the main keymap. | 516 | "Non-nil if the vcursor map is mapped directly onto the main keymap. |
| 517 | See vcursor-toggle-vcursor-map.") | 517 | See `vcursor-toggle-vcursor-map'.") |
| 518 | (make-variable-buffer-local 'vcursor-use-vcursor-map) | 518 | (make-variable-buffer-local 'vcursor-use-vcursor-map) |
| 519 | 519 | ||
| 520 | (defvar vcursor-map nil "Keymap for vcursor command.") | 520 | (defvar vcursor-map nil "Keymap for vcursor command.") |
| @@ -575,7 +575,7 @@ With optional NOT-THIS non-nil never return the current window. | |||
| 575 | 575 | ||
| 576 | With NEW-WIN non-nil, display the virtual cursor buffer in another | 576 | With NEW-WIN non-nil, display the virtual cursor buffer in another |
| 577 | window if the virtual cursor is not currently visible \(note, however, | 577 | window if the virtual cursor is not currently visible \(note, however, |
| 578 | that this function never changes window-point\). | 578 | that this function never changes `window-point'\). |
| 579 | 579 | ||
| 580 | With THIS-FRAME non-nil, don't search other frames for a new window | 580 | With THIS-FRAME non-nil, don't search other frames for a new window |
| 581 | \(though if the vcursor is already off-frame then its current window is | 581 | \(though if the vcursor is already off-frame then its current window is |
| @@ -674,15 +674,15 @@ another window. With LEAVE-W, use the current `vcursor-window'." | |||
| 674 | (insert text)) | 674 | (insert text)) |
| 675 | ) | 675 | ) |
| 676 | 676 | ||
| 677 | (defun vcursor-relative-move (fn &rest args) | 677 | (defun vcursor-relative-move (func &rest args) |
| 678 | "Use FUNCTION with arbitrary ARG1 ... to move the virtual cursor. | 678 | "Call FUNC with arbitrary ARGS ... to move the virtual cursor. |
| 679 | 679 | ||
| 680 | This is called by most of the virtual-cursor motion commands." | 680 | This is called by most of the virtual-cursor motion commands." |
| 681 | (let (text opoint) | 681 | (let (text opoint) |
| 682 | (save-excursion | 682 | (save-excursion |
| 683 | (vcursor-locate) | 683 | (vcursor-locate) |
| 684 | (setq opoint (point)) | 684 | (setq opoint (point)) |
| 685 | (apply fn args) | 685 | (apply func args) |
| 686 | (and (eq opoint (point-max)) (eq opoint (point)) | 686 | (and (eq opoint (point-max)) (eq opoint (point)) |
| 687 | (signal 'end-of-buffer nil)) | 687 | (signal 'end-of-buffer nil)) |
| 688 | (vcursor-move (point)) | 688 | (vcursor-move (point)) |
| @@ -730,7 +730,7 @@ The vcursor will always appear in an unselected window." | |||
| 730 | ) | 730 | ) |
| 731 | 731 | ||
| 732 | (defun vcursor-scroll-down (&optional n) | 732 | (defun vcursor-scroll-down (&optional n) |
| 733 | "Scroll down the vcursor window ARG lines or near-full screen if none. | 733 | "Scroll down the vcursor window ARG lines or near full screen if none. |
| 734 | The vcursor will always appear in an unselected window." | 734 | The vcursor will always appear in an unselected window." |
| 735 | 735 | ||
| 736 | (interactive "P") | 736 | (interactive "P") |
| @@ -791,10 +791,10 @@ is visible in the current one." | |||
| 791 | (setq vcursor-last-command t) | 791 | (setq vcursor-last-command t) |
| 792 | ) | 792 | ) |
| 793 | 793 | ||
| 794 | (defun vcursor-get-char-count (fn &rest args) | 794 | (defun vcursor-get-char-count (func &rest args) |
| 795 | "Apply FN to ARG1 ... and return the number of characters moved. | 795 | "Apply FUNC to ARGS ... and return the number of characters moved. |
| 796 | Point is temporarily set to the virtual cursor position before FN is | 796 | Point is temporarily set to the virtual cursor position before FUNC |
| 797 | called. | 797 | is called. |
| 798 | 798 | ||
| 799 | This is called by most of the virtual-cursor copying commands to find | 799 | This is called by most of the virtual-cursor copying commands to find |
| 800 | out how much to copy." | 800 | out how much to copy." |
| @@ -803,7 +803,7 @@ out how much to copy." | |||
| 803 | (save-excursion | 803 | (save-excursion |
| 804 | (set-buffer (overlay-buffer vcursor-overlay)) | 804 | (set-buffer (overlay-buffer vcursor-overlay)) |
| 805 | (let ((start (goto-char (overlay-start vcursor-overlay)))) | 805 | (let ((start (goto-char (overlay-start vcursor-overlay)))) |
| 806 | (- (progn (apply fn args) (point)) start))) | 806 | (- (progn (apply func args) (point)) start))) |
| 807 | ) | 807 | ) |
| 808 | 808 | ||
| 809 | ;; Make sure the virtual cursor is active. Unless arg is non-nil, | 809 | ;; Make sure the virtual cursor is active. Unless arg is non-nil, |
| @@ -822,13 +822,12 @@ Next time you use it, it will start from point. | |||
| 822 | 822 | ||
| 823 | With a positive prefix ARG, the first window in cyclic order | 823 | With a positive prefix ARG, the first window in cyclic order |
| 824 | displaying the virtual cursor (or which was recently displaying the | 824 | displaying the virtual cursor (or which was recently displaying the |
| 825 | virtual cursor) will be deleted unless it's the selected | 825 | virtual cursor) will be deleted unless it's the selected window. |
| 826 | window. | ||
| 827 | 826 | ||
| 828 | With a negative prefix argument, enable the virtual cursor: make it | 827 | With a negative prefix argument, enable the virtual cursor: make it |
| 829 | active at the same point as the real cursor. | 828 | active at the same point as the real cursor. |
| 830 | 829 | ||
| 831 | Copying mode is always turned off: the next use of the vcursor will | 830 | Copying mode is always turned off: the next use of the vcursor will |
| 832 | not copy text until you turn it on again." | 831 | not copy text until you turn it on again." |
| 833 | 832 | ||
| 834 | (interactive "P") | 833 | (interactive "P") |
| @@ -854,7 +853,7 @@ This is the next window cyclically after one currently showing the | |||
| 854 | virtual cursor, or else after the current selected window. If there | 853 | virtual cursor, or else after the current selected window. If there |
| 855 | is no other window, the current window is split. | 854 | is no other window, the current window is split. |
| 856 | 855 | ||
| 857 | Arguments N and optional ALL-FRAMES are the same as with other-window. | 856 | Arguments N and optional ALL-FRAMES are the same as with `other-window'. |
| 858 | ALL-FRAMES is also used to decide whether to split the window." | 857 | ALL-FRAMES is also used to decide whether to split the window." |
| 859 | 858 | ||
| 860 | (interactive "p") | 859 | (interactive "p") |
| @@ -1042,7 +1041,7 @@ ARG is as for `end-of-line'." | |||
| 1042 | 1041 | ||
| 1043 | (defun vcursor-beginning-of-buffer (&optional arg) | 1042 | (defun vcursor-beginning-of-buffer (&optional arg) |
| 1044 | "Move the virtual cursor to the beginning of its buffer. | 1043 | "Move the virtual cursor to the beginning of its buffer. |
| 1045 | ARG is as for beginning-of-buffer." | 1044 | ARG is as for `beginning-of-buffer'." |
| 1046 | (interactive "P") | 1045 | (interactive "P") |
| 1047 | (vcursor-relative-move | 1046 | (vcursor-relative-move |
| 1048 | (lambda (arg) | 1047 | (lambda (arg) |
| @@ -1053,7 +1052,7 @@ ARG is as for beginning-of-buffer." | |||
| 1053 | 1052 | ||
| 1054 | (defun vcursor-end-of-buffer (&optional arg) | 1053 | (defun vcursor-end-of-buffer (&optional arg) |
| 1055 | "Move the virtual cursor to the end of its buffer. | 1054 | "Move the virtual cursor to the end of its buffer. |
| 1056 | ARG is as for end-of-buffer. | 1055 | ARG is as for `end-of-buffer'. |
| 1057 | 1056 | ||
| 1058 | Actually, the vcursor is moved to the second from last character or it | 1057 | Actually, the vcursor is moved to the second from last character or it |
| 1059 | would be invisible." | 1058 | would be invisible." |