summaryrefslogtreecommitdiff
path: root/doc/lispref/internals.texi
diff options
context:
space:
mode:
authorXue Fuqiao <xfq.free@gmail.com>2013-04-21 19:16:30 +0800
committerXue Fuqiao <xfq.free@gmail.com>2013-04-21 19:16:30 +0800
commit84ebefe92fde8f636ceed2e51f6489876280be71 (patch)
treea47efe7230d1735e77df352ce503d692141e659e /doc/lispref/internals.texi
parentf8152bcb327ef9a7b66974b029b617e06461ebab (diff)
downloademacs-84ebefe92fde8f636ceed2e51f6489876280be71.tar.gz
* doc/lispref/internals.texi (Writing Emacs Primitives): Remove unnecessary references to the sources. (Bug#13800)
Diffstat (limited to 'doc/lispref/internals.texi')
-rw-r--r--doc/lispref/internals.texi34
1 files changed, 26 insertions, 8 deletions
diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi
index 3269776b626..24440858b7e 100644
--- a/doc/lispref/internals.texi
+++ b/doc/lispref/internals.texi
@@ -661,15 +661,33 @@ equivalent of @code{&rest}). Both @code{UNEVALLED} and @code{MANY} are
macros. If @var{max} is a number, it must be more than @var{min} but
less than 8.
+@cindex interactive specification in primitives
@item interactive
-This is an interactive specification, a string such as might be used as
-the argument of @code{interactive} in a Lisp function. In the case of
-@code{or}, it is 0 (a null pointer), indicating that @code{or} cannot be
-called interactively. A value of @code{""} indicates a function that
-should receive no arguments when called interactively. If the value
-begins with a @samp{(}, the string is evaluated as a Lisp form.
-For examples of the last two forms, see @code{widen} and
-@code{narrow-to-region} in @file{editfns.c}.
+This is an interactive specification, a string such as might be used
+as the argument of @code{interactive} in a Lisp function. In the case
+of @code{or}, it is 0 (a null pointer), indicating that @code{or}
+cannot be called interactively. A value of @code{""} indicates a function that should receive no
+arguments when called interactively. For example:
+
+@smallexample
+@group
+DEFUN ("baz", Fbaz, Sbaz, 0, 0, "",
+ doc: /* @dots{} */)
+@end group
+@end smallexample
+
+If the value begins with a @samp{"(}, the string is evaluated as a
+Lisp form. For example:
+
+@smallexample
+@group
+DEFUN ("foo", Ffoo, Sfoo, 0, UNEVALLED, "(list
+ (read-char-by-name \"Insert character (Unicode name or hex): \")\
+ (prefix-numeric-value current-prefix-arg)\
+ t))",
+ doc: /* @dots{} /*)
+@end group
+@end smallexample
@item doc
This is the documentation string. It uses C comment syntax rather