]> code.delx.au - gnu-emacs/commitdiff
(help-buffer): Add docstring.
authorChong Yidong <cyd@stupidchicken.com>
Mon, 30 Mar 2009 01:06:27 +0000 (01:06 +0000)
committerChong Yidong <cyd@stupidchicken.com>
Mon, 30 Mar 2009 01:06:27 +0000 (01:06 +0000)
lisp/help-mode.el

index d1e89705077298581ff89cfda0248934113e5c2c..bbd1dfec131018f94df01a5b10a772b344828f8a 100644 (file)
@@ -358,6 +358,10 @@ restore it properly when going back."
 
 ;;;###autoload
 (defun help-buffer ()
+  "Return a buffer for inserting help.
+If `help-xref-following' is non-nil, this is the current buffer.
+Otherwise, it is the buffer named *Help*.  If no such buffer
+currently exists, it is created."
   (buffer-name                         ;for with-output-to-temp-buffer
    (if help-xref-following
        (current-buffer)