procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* doc/lispref/internals.texi (Writing Emacs Primitives): Remove unnecessary references to the sources. (Bug#13800)

Browse source
This commit is contained in:
Xue Fuqiao 2013-04-21 19:16:30 +08:00
parent f8152bcb32
commit 84ebefe92f
2 changed files with 29 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/lispref/ChangeLog
View file

@ -1,5 +1,8 @@
2013-04-21 Xue Fuqiao <xfq.free@gmail.com>
* internals.texi (Writing Emacs Primitives): Remove unnecessary
references to the sources. (Bug#13800)
* searching.texi (Regexp Backslash): Doc fix for backslash
constructs in regular expressions.

34
doc/lispref/internals.texi
View file

@ -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