]> code.delx.au - gnu-emacs/blobdiff - lisp/help-mode.el
(mailclient-send-it): Fix message.
[gnu-emacs] / lisp / help-mode.el
index 912be60706c44cd885f3111f5b875c666786ff56..91fb4f9925754d9e3695ff209af4516015f05c9e 100644 (file)
@@ -1,7 +1,7 @@
 ;;; help-mode.el --- `help-mode' used by *Help* buffers
 
 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002,
-;;   2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;;   2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 ;; Keywords: help, internal
@@ -67,7 +67,7 @@ To use the element, do (apply FUNCTION ARGS) then goto the point.")
 (make-variable-buffer-local 'help-xref-stack)
 
 (defvar help-xref-forward-stack nil
-  "The stack of used to navigate help forwards  after using the back button.
+  "A stack used to navigate help forwards after using the back button.
 Used by `help-follow' and `help-xref-go-forward'.
 An element looks like (POSITION FUNCTION ARGS...).
 To use the element, do (apply FUNCTION ARGS) then goto the point.")
@@ -358,6 +358,11 @@ restore it properly when going back."
 
 ;;;###autoload
 (defun help-buffer ()
+  "Return the name of a buffer for inserting help.
+If `help-xref-following' is non-nil, this is the name of the
+current buffer.
+Otherwise, it is *Help*; if no buffer with that name currently
+exists, it is created."
   (buffer-name                         ;for with-output-to-temp-buffer
    (if help-xref-following
        (current-buffer)