diff options
Diffstat (limited to 'lispref/loading.texi')
| -rw-r--r-- | lispref/loading.texi | 13 |
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: | |||
| 481 | Here's what that produces in @file{loaddefs.el}: | 481 | Here's what that produces in @file{loaddefs.el}: |
| 482 | 482 | ||
| 483 | @smallexample | 483 | @smallexample |
| 484 | (autoload 'doctor "doctor" "\ | 484 | (autoload (quote doctor) "doctor" "\ |
| 485 | Switch to *doctor* buffer and start giving psychotherapy." | 485 | Switch 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 | ||
| 490 | The backslash and newline immediately following the double-quote are a | 492 | The backslash and newline immediately following the double-quote are a |
| 491 | convention used only in the preloaded uncompiled Lisp files such as | 493 | convention 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 |
| 493 | documentation string in the @file{etc/DOC} file. @xref{Building Emacs}. | 495 | documentation string in the @file{etc/DOC} file. @xref{Building Emacs}. |
| 494 | See also the commentary in @file{lib-src/make-docfile.c}. | 496 | See also the commentary in @file{lib-src/make-docfile.c}. @samp{(fn)} |
| 497 | in the usage part of the documentation string is replaced with the | ||
| 498 | function's name when the various help functions (@pxref{Help | ||
| 499 | Functions}) 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 |
| 497 | one of the known and recognized function definition methods, use of an | 502 | one of the known and recognized function definition methods, use of an |