aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAndreas Schwab2009-07-01 14:52:28 +0000
committerAndreas Schwab2009-07-01 14:52:28 +0000
commit77c7e2e15f6286a46da64fd51b9a5cc80663b1b6 (patch)
tree97c33de8fde1547e96b9f01b95b7ceb23a647cf2 /doc
parent3f1c666608f7ca4aeacbcbe5102c2c2c63e345e9 (diff)
downloademacs-77c7e2e15f6286a46da64fd51b9a5cc80663b1b6.tar.gz
emacs-77c7e2e15f6286a46da64fd51b9a5cc80663b1b6.zip
(Help Functions): Fix description of help-buffer and
help-setup-xref to use @defun instead of @deffn.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog5
-rw-r--r--doc/lispref/help.texi8
2 files changed, 9 insertions, 4 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index e985de0cc37..0d93589e6b2 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
12009-07-01 Andreas Schwab <aschwab@redhat.com>
2
3 * help.texi (Help Functions): Fix description of help-buffer and
4 help-setup-xref to use @defun instead of @deffn.
5
12009-07-01 Jan Djärv <jan.h.d@swipnet.se> 62009-07-01 Jan Djärv <jan.h.d@swipnet.se>
2 7
3 * frames.texi (Size Parameters): Mention maximized for fullscreen. 8 * frames.texi (Size Parameters): Mention maximized for fullscreen.
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
637certain documentation and text files that come with Emacs. 637certain documentation and text files that come with Emacs.
638@end defvar 638@end defvar
639 639
640@deffn help-buffer 640@defun help-buffer
641This function returns the name of the help buffer, which is normally 641This function returns the name of the help buffer, which is normally
642@samp{*Help*}; if such a buffer does not exist, it is first created. 642@samp{*Help*}; if such a buffer does not exist, it is first created.
643@end deffn 643@end defun
644 644
645@defmac with-help-window buffer-name body@dots{} 645@defmac with-help-window buffer-name body@dots{}
646This macro evaluates the @var{body} forms, inserting any output they 646This 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
652scroll the help window. 652scroll the help window.
653@end defmac 653@end defmac
654 654
655@deffn help-setup-xref item interactive-p 655@defun help-setup-xref item interactive-p
656This function updates the cross reference data in the @samp{*Help*} 656This function updates the cross reference data in the @samp{*Help*}
657buffer, which is used to regenerate the help information when the user 657buffer, which is used to regenerate the help information when the user
658clicks on the @samp{Back} or @samp{Forward} buttons. Most commands 658clicks 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.
663The @var{interactive-p} argument is non-@code{nil} if the calling 663The @var{interactive-p} argument is non-@code{nil} if the calling
664command was invoked interactively; in that case, the stack of items 664command was invoked interactively; in that case, the stack of items
665for the @samp{*Help*} buffer's @samp{Back} buttons is cleared. 665for the @samp{*Help*} buffer's @samp{Back} buttons is cleared.
666@end deffn 666@end defun
667 667
668@xref{describe-symbols example}, for an example of using 668@xref{describe-symbols example}, for an example of using
669@code{help-buffer}, @code{with-help-window}, and 669@code{help-buffer}, @code{with-help-window}, and