(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.

diff --git a/lispref/ChangeLog b/lispref/ChangeLog
index 74431dc03be339c748134b4db569c7a2dab24ee8..cee4c55eb7dc8446e2a1c6f0ce642a4c821537fb 100644 (file)
--- a/lispref/ChangeLog
+++ b/lispref/ChangeLog
@@ -1,3 +1,9 @@
+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.

diff --git a/lispref/loading.texi b/lispref/loading.texi
index 4049877e7826ac5db71b48189d2d16bb0e9deec3..b64a0ce673653a51f6348cab92f06f44f31a65ca 100644 (file)
--- a/lispref/loading.texi
+++ b/lispref/loading.texi
@@ -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