diff options
| author | Andreas Schwab <schwab@linux-m68k.org> | 2009-07-01 14:58:44 +0000 |
|---|---|---|
| committer | Andreas Schwab <schwab@linux-m68k.org> | 2009-07-01 14:58:44 +0000 |
| commit | 42e767f2f788a57c728895df5ccf3c3e153f7260 (patch) | |
| tree | a670369a86e53048aee6a3de1ddaade49ca6bdfd | |
| parent | 0ad07dbec1f163aafa5753a764c34fc83e0e9a0c (diff) | |
| download | emacs-42e767f2f788a57c728895df5ccf3c3e153f7260.tar.gz | |
(Help Functions): Fix description of help-buffer and
help-setup-xref to use @defun instead of @deffn.
| -rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispref/help.texi | 8 |
2 files changed, 9 insertions, 4 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 363c5ae6c05..89d23d55f1b 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -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-06-24 Chong Yidong <cyd@stupidchicken.com> * display.texi (Window Systems): Add ns to the list. diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 19fa348463a..bb38aabfa66 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -637,10 +637,10 @@ This variable holds the name of the directory in which Emacs finds 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 @@ Help mode and displays a message telling the user how to quit and 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 @@ to call, with argument list @var{args}, to regenerate the help buffer. 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 |