Mercurial > emacs
changeset 103666:3337a01621b2
(Help Functions): Fix description of help-buffer and
help-setup-xref to use @defun instead of @deffn.
| author | Andreas Schwab <schwab@linux-m68k.org> |
|---|---|
| date | Wed, 01 Jul 2009 14:52:28 +0000 |
| parents | 340c701162a6 |
| children | c97659625a0c |
| files | doc/lispref/ChangeLog doc/lispref/help.texi |
| diffstat | 2 files changed, 9 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/lispref/ChangeLog Wed Jul 01 14:02:27 2009 +0000 +++ b/doc/lispref/ChangeLog Wed Jul 01 14:52:28 2009 +0000 @@ -1,3 +1,8 @@ +2009-07-01 Andreas Schwab <aschwab@redhat.com> + + * help.texi (Help Functions): Fix description of help-buffer and + help-setup-xref to use @defun instead of @deffn. + 2009-07-01 Jan Djärv <jan.h.d@swipnet.se> * frames.texi (Size Parameters): Mention maximized for fullscreen.
--- a/doc/lispref/help.texi Wed Jul 01 14:02:27 2009 +0000 +++ b/doc/lispref/help.texi Wed Jul 01 14:52:28 2009 +0000 @@ -637,10 +637,10 @@ certain documentation and text files that come with Emacs. @end defvar -@deffn help-buffer +@defun help-buffer This function returns the name of the help buffer, which is normally @samp{*Help*}; if such a buffer does not exist, it is first created. -@end deffn +@end defun @defmac with-help-window buffer-name body@dots{} This macro evaluates the @var{body} forms, inserting any output they @@ -652,7 +652,7 @@ scroll the help window. @end defmac -@deffn help-setup-xref item interactive-p +@defun help-setup-xref item interactive-p This function updates the cross reference data in the @samp{*Help*} buffer, which is used to regenerate the help information when the user clicks on the @samp{Back} or @samp{Forward} buttons. Most commands @@ -663,7 +663,7 @@ The @var{interactive-p} argument is non-@code{nil} if the calling command was invoked interactively; in that case, the stack of items for the @samp{*Help*} buffer's @samp{Back} buttons is cleared. -@end deffn +@end defun @xref{describe-symbols example}, for an example of using @code{help-buffer}, @code{with-help-window}, and