summaryrefslogtreecommitdiff
path: root/lisp/obsolete/levents.el
diff options
context:
space:
mode:
authorJuanma Barranquero <lekktu@gmail.com>2010-03-22 17:50:29 +0100
committerJuanma Barranquero <lekktu@gmail.com>2010-03-22 17:50:29 +0100
commitc8de140b340e26e507d55005621684d6e7657ecd (patch)
tree5f0916c0d2436ac389c0b8c207221970c5b08dad /lisp/obsolete/levents.el
parent5f76fe28b98ceec8ab3a7aacc4a0281679d818ee (diff)
downloademacs-c8de140b340e26e507d55005621684d6e7657ecd.tar.gz
Fix typos in docstrings.
* image-dired.el (image-dired-display-thumbs): Fix typo in docstring. (image-dired-read-comment): Doc fix. * json.el (json-object-type, json-array-type, json-key-type, json-false) (json-null, json-read-number): * minibuffer.el (completion-in-region-functions): * calendar/cal-tex.el (cal-tex-daily-end, cal-tex-number-weeks) (cal-tex-cursor-week): * emacs-lisp/trace.el (trace-function): * eshell/em-basic.el (eshell/printnl): * eshell/em-dirs.el (eshell-last-dir-ring, eshell-parse-drive-letter) (eshell-read-last-dir-ring, eshell-write-last-dir-ring): * obsolete/levents.el (allocate-event, event-key, event-object) (event-point, event-process, event-timestamp, event-to-character) (event-window, event-x, event-x-pixel, event-y, event-y-pixel): * textmodes/reftex-vars.el (reftex-index-macros-builtin) (reftex-section-levels, reftex-auto-recenter-toc, reftex-toc-mode-hook) (reftex-cite-punctuation, reftex-search-unrecursed-path-first) (reftex-highlight-selection): Fix typos in docstrings.
Diffstat (limited to 'lisp/obsolete/levents.el')
-rw-r--r--lisp/obsolete/levents.el24
1 files changed, 12 insertions, 12 deletions
diff --git a/lisp/obsolete/levents.el b/lisp/obsolete/levents.el
index 652994ebd7a..1715185ac05 100644
--- a/lisp/obsolete/levents.el
+++ b/lisp/obsolete/levents.el
@@ -61,7 +61,7 @@
(put 'timeout 'event-symbol-elements '(eval))
(defun allocate-event ()
- "Returns an empty event structure.
+ "Return an empty event structure.
In this emulation, it returns nil."
nil)
@@ -142,7 +142,7 @@ It will be the next event read after all pending events."
(nth 1 event))
(defun event-key (event)
- "Returns the KeySym of the given key-press event.
+ "Return the KeySym of the given key-press event.
The value is an ASCII printing character (not upper case) or a symbol."
(if (symbolp event)
(car (get event 'event-symbol-elements))
@@ -150,11 +150,11 @@ The value is an ASCII printing character (not upper case) or a symbol."
(downcase (if (< base 32) (logior base 64) base)))))
(defun event-object (event)
- "Returns the function argument of the given timeout, menu, or eval event."
+ "Return the function argument of the given timeout, menu, or eval event."
(nth 2 event))
(defun event-point (event)
- "Returns the character position of the given mouse-related event.
+ "Return the character position of the given mouse-related event.
If the event did not occur over a window, or did
not occur over text, then this returns nil. Otherwise, it returns an index
into the buffer visible in the event's window."
@@ -201,18 +201,18 @@ or for window WINDOW if that is specified."
(window-start start-window)))))
(defun event-process (event)
- "Returns the process of the given process-output event."
+ "Return the process of the given process-output event."
(nth 1 event))
(defun event-timestamp (event)
- "Returns the timestamp of the given event object.
+ "Return the timestamp of the given event object.
In Lucid Emacs, this works for any kind of event.
In this emulation, it returns nil for non-mouse-related events."
(and (listp event)
(posn-timestamp (event-end event))))
(defun event-to-character (event &optional lenient)
- "Returns the closest ASCII approximation to the given event object.
+ "Return the closest ASCII approximation to the given event object.
If the event isn't a keypress, this returns nil.
If the second argument is non-nil, then this is lenient in its
translation; it will ignore modifier keys other than control and meta,
@@ -229,25 +229,25 @@ will be returned for events which have no direct ASCII equivalent."
event nil)))
(defun event-window (event)
- "Returns the window of the given mouse-related event object."
+ "Return the window of the given mouse-related event object."
(posn-window (event-end event)))
(defun event-x (event)
- "Returns the X position in characters of the given mouse-related event."
+ "Return the X position in characters of the given mouse-related event."
(/ (car (posn-col-row (event-end event)))
(frame-char-width (window-frame (event-window event)))))
(defun event-x-pixel (event)
- "Returns the X position in pixels of the given mouse-related event."
+ "Return the X position in pixels of the given mouse-related event."
(car (posn-col-row (event-end event))))
(defun event-y (event)
- "Returns the Y position in characters of the given mouse-related event."
+ "Return the Y position in characters of the given mouse-related event."
(/ (cdr (posn-col-row (event-end event)))
(frame-char-height (window-frame (event-window event)))))
(defun event-y-pixel (event)
- "Returns the Y position in pixels of the given mouse-related event."
+ "Return the Y position in pixels of the given mouse-related event."
(cdr (posn-col-row (event-end event))))
(defun key-press-event-p (obj)