changeset 76017:f110ee6599bf

(speedbar-frame-mode, speedbar-frame-width, speedbar-show-unknown-files, speedbar-item-info-file-helper, speedbar-item-info-tag-helper): Doc fixes.
author Juanma Barranquero <lekktu@gmail.com>
date Mon, 19 Feb 2007 13:37:23 +0000
parents dea718e903a0
children 6b709e9b87da
files lisp/speedbar.el
diffstat 1 files changed, 6 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/speedbar.el	Mon Feb 19 10:56:04 2007 +0000
+++ b/lisp/speedbar.el	Mon Feb 19 13:37:23 2007 +0000
@@ -316,7 +316,7 @@
 
 (defcustom speedbar-show-unknown-files nil
   "*Non-nil show files we can't expand with a ? in the expand button.
-nil means don't show the file in the list."
+A nil value means don't show the file in the list."
   :group 'speedbar
   :type 'boolean)
 
@@ -975,7 +975,7 @@
 ;;;###autoload
 (defun speedbar-frame-mode (&optional arg)
   "Enable or disable speedbar.  Positive ARG means turn on, negative turn off.
-nil means toggle.  Once the speedbar frame is activated, a buffer in
+A nil ARG means toggle.  Once the speedbar frame is activated, a buffer in
 `speedbar-mode' will be displayed.  Currently, only one speedbar is
 supported at a time.
 `speedbar-before-popup-hook' is called before popping up the speedbar frame.
@@ -1071,7 +1071,7 @@
 
 (defsubst speedbar-frame-width ()
   "Return the width of the speedbar frame in characters.
-nil if it doesn't exist."
+Return nil if it doesn't exist."
   (frame-width speedbar-frame))
 
 (defun speedbar-mode ()
@@ -1482,8 +1482,8 @@
 
 (defun speedbar-item-info-file-helper (&optional filename)
   "Display info about a file that is on the current line.
-nil if not applicable.  If FILENAME, then use that instead of reading
-it from the speedbar buffer."
+Return nil if not applicable.  If FILENAME, then use that
+instead of reading it from the speedbar buffer."
   (let* ((item (or filename (speedbar-line-file)))
 	 (attr (if item (file-attributes item) nil)))
     (if (and item attr) (speedbar-message "%s %-6d %s" (nth 8 attr)
@@ -1492,7 +1492,7 @@
 
 (defun speedbar-item-info-tag-helper ()
   "Display info about a tag that is on the current line.
-nil if not applicable."
+Return nil if not applicable."
   (save-excursion
     (beginning-of-line)
     (if (re-search-forward " [-+=]?> \\([^\n]+\\)"