summaryrefslogtreecommitdiff
path: root/lispref
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2005-07-23 10:22:44 +0000
committerEli Zaretskii <eliz@gnu.org>2005-07-23 10:22:44 +0000
commitba6ebbd500397d924833ee8912f9f9b823731bab (patch)
tree2511f621c9214a0963457cee6ddecc97008887f7 /lispref
parent99f963e4ea6fa3ca4498731c271d07914e86ea1d (diff)
downloademacs-ba6ebbd500397d924833ee8912f9f9b823731bab.tar.gz
(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.
Diffstat (limited to 'lispref')
-rw-r--r--lispref/ChangeLog6
-rw-r--r--lispref/loading.texi13
2 files changed, 15 insertions, 4 deletions
diff --git a/lispref/ChangeLog b/lispref/ChangeLog
index 74431dc03be..cee4c55eb7d 100644
--- 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 4049877e782..b64a0ce6736 100644
--- 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