Commit ba6ebbd5 authored by Eli Zaretskii's avatar Eli Zaretskii
Browse files

(Autoload): Make the `doctor' example be consistent

with what's in current loaddefs.el.  Describe the "fn" magic in
the usage portion of the doc string.
parent 99f963e4
2005-07-23 Eli Zaretskii <eliz@gnu.org>
* loading.texi (Autoload): Make the `doctor' example be consistent
with what's in current loaddefs.el. Describe the "fn" magic in
the usage portion of the doc string.
2005-07-22 Richard M. Stallman <rms@gnu.org>
* internals.texi (Garbage Collection): Clarify previous change.
......
......@@ -481,17 +481,22 @@ autoloading with a magic comment:
Here's what that produces in @file{loaddefs.el}:
@smallexample
(autoload 'doctor "doctor" "\
Switch to *doctor* buffer and start giving psychotherapy."
t)
(autoload (quote doctor) "doctor" "\
Switch to *doctor* buffer and start giving psychotherapy.
\(fn)" t nil)
@end smallexample
@noindent
@cindex @code{fn} in function's documentation string
The backslash and newline immediately following the double-quote are a
convention used only in the preloaded uncompiled Lisp files such as
@file{loaddefs.el}; they tell @code{make-docfile} to put the
documentation string in the @file{etc/DOC} file. @xref{Building Emacs}.
See also the commentary in @file{lib-src/make-docfile.c}.
See also the commentary in @file{lib-src/make-docfile.c}. @samp{(fn)}
in the usage part of the documentation string is replaced with the
function's name when the various help functions (@pxref{Help
Functions}) display it.
If you write a function definition with an unusual macro that is not
one of the known and recognized function definition methods, use of an
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment