Index: emacs/lispref/loading.texi
diff -c emacs/lispref/loading.texi:1.55 emacs/lispref/loading.texi:1.56
*** emacs/lispref/loading.texi:1.55 Sat May 14 15:22:36 2005
--- emacs/lispref/loading.texi Sat Jul 23 10:22:25 2005
***************
*** 481,497 ****
Here's what that produces in @file{loaddefs.el}:
@smallexample
! (autoload 'doctor "doctor" "\
! Switch to *doctor* buffer and start giving psychotherapy."
! t)
@end smallexample
@noindent
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}.
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
--- 481,502 ----
Here's what that produces in @file{loaddefs.el}:
@smallexample
! (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}. @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
_______________________________________________
Emacs-diffs mailing list
[email protected]
http://lists.gnu.org/mailman/listinfo/emacs-diffs