aboutsummaryrefslogtreecommitdiffstats
path: root/lispref/loading.texi
diff options
context:
space:
mode:
Diffstat (limited to 'lispref/loading.texi')
-rw-r--r--lispref/loading.texi13
1 files changed, 9 insertions, 4 deletions
diff --git a/lispref/loading.texi b/lispref/loading.texi
index 4049877e782..b64a0ce6736 100644
--- a/lispref/loading.texi
+++ b/lispref/loading.texi
@@ -481,17 +481,22 @@ autoloading with a magic comment:
481Here's what that produces in @file{loaddefs.el}: 481Here's what that produces in @file{loaddefs.el}:
482 482
483@smallexample 483@smallexample
484(autoload 'doctor "doctor" "\ 484(autoload (quote doctor) "doctor" "\
485Switch to *doctor* buffer and start giving psychotherapy." 485Switch to *doctor* buffer and start giving psychotherapy.
486 t) 486
487\(fn)" t nil)
487@end smallexample 488@end smallexample
488 489
489@noindent 490@noindent
491@cindex @code{fn} in function's documentation string
490The backslash and newline immediately following the double-quote are a 492The backslash and newline immediately following the double-quote are a
491convention used only in the preloaded uncompiled Lisp files such as 493convention used only in the preloaded uncompiled Lisp files such as
492@file{loaddefs.el}; they tell @code{make-docfile} to put the 494@file{loaddefs.el}; they tell @code{make-docfile} to put the
493documentation string in the @file{etc/DOC} file. @xref{Building Emacs}. 495documentation string in the @file{etc/DOC} file. @xref{Building Emacs}.
494See also the commentary in @file{lib-src/make-docfile.c}. 496See also the commentary in @file{lib-src/make-docfile.c}. @samp{(fn)}
497in the usage part of the documentation string is replaced with the
498function's name when the various help functions (@pxref{Help
499Functions}) display it.
495 500
496 If you write a function definition with an unusual macro that is not 501 If you write a function definition with an unusual macro that is not
497one of the known and recognized function definition methods, use of an 502one of the known and recognized function definition methods, use of an