]> git.eshelyaron.com Git - emacs.git/commitdiff
(Help Functions): Fix description of help-buffer and
authorAndreas Schwab <schwab@linux-m68k.org>
Wed, 1 Jul 2009 14:52:28 +0000 (14:52 +0000)
committerAndreas Schwab <schwab@linux-m68k.org>
Wed, 1 Jul 2009 14:52:28 +0000 (14:52 +0000)
help-setup-xref to use @defun instead of @deffn.

doc/lispref/ChangeLog
doc/lispref/help.texi

index e985de0cc37b3e0c9fb5468b4137f76b617468d3..0d93589e6b2fc997ce56835d6efd1be8f6f824a8 100644 (file)
@@ -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.
index 19fa348463a63b1c47c63e9a1569dc792eea8d56..bb38aabfa6631452cbf9e7922e7cb2f13186c344 100644 (file)
@@ -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