]> git.eshelyaron.com Git - emacs.git/commitdiff
Document 'timerp'
authorEli Zaretskii <eliz@gnu.org>
Fri, 23 Sep 2016 08:43:25 +0000 (11:43 +0300)
committerEli Zaretskii <eliz@gnu.org>
Fri, 23 Sep 2016 08:43:25 +0000 (11:43 +0300)
* doc/lispref/os.texi (Timers): Document 'timerp'.  (Bug#24511)
Improve indexing.

doc/lispref/os.texi

index ec14b014e52cbc32594187f4aaa660b4e1c231f9..0d999ae9b9997e89221cccb91c872f2e5aff99b1 100644 (file)
@@ -1727,10 +1727,17 @@ This function returns @code{t} if @var{year} is a leap year.
 
 @node Timers
 @section Timers for Delayed Execution
-@cindex timer
+@cindex timers
 
   You can set up a @dfn{timer} to call a function at a specified
-future time or after a certain length of idleness.
+future time or after a certain length of idleness.  A timer is a
+special object that stores the information about the next invocation
+times and the function to invoke.
+
+@defun timerp object
+This predicate function returns non-@code{nil} of @code{object} is a
+timer.
+@end defun
 
   Emacs cannot run timers at any arbitrary point in a Lisp program; it
 can run them only when Emacs could accept output from a subprocess: