* facemenu.el (facemenu-unlisted-faces): Fix obsolescence declaration.
* hi-lock.el (hi-lock-mode): Fix typo in docstring.
* icomplete.el (icomplete-compute-delay, icomplete-get-keys): Doc fixes.
(icomplete-delay-completions-threshold): Fix typo in docstring.
* speedbar.el (speedbar-stealthy-function-list)
(speedbar-verbosity-level, speedbar-supported-extension-expressions)
(speedbar-update-current-file, speedbar-add-indicator)
(speedbar-tag-expand): Reflow docstrings.
(speedbar-use-imenu-flag, speedbar-use-tool-tips-flag)
(speedbar-ignored-directory-regexp, speedbar-file-unshown-regexp)
(speedbar-file-regexp, speedbar-message, speedbar-item-info)
(speedbar-files-item-info, speedbar-fetch-replacement-function)
(speedbar-maybe-add-localized-support)
(speedbar-generic-list-positioned-group-p, speedbar-insert-generic-list)
(speedbar-extract-one-symbol, speedbar-recenter-to-top)
(speedbar-recenter, speedbar-separator-face): Fix typos in docstrings.
(speedbar-ignored-directory-expressions, speedbar-handle-delete-frame)
(speedbar-show-info-under-mouse, speedbar-directory-buttons)
(speedbar-check-vc-this-line, speedbar-files-line-directory)
(speedbar-buffer-buttons, speedbar-buffer-buttons-temp)
(speedbar-buffers-line-directory): Doc fixes.
* tool-bar.el (tool-bar-add-item): Fix typo in docstring.
* emacs-lisp/edebug.el (edebug-unwrap*, edebug-signal)
(edebug-restore-status): Doc fixes.
(edebug-gensym, edebug-top-level-nonstop, edebug-eval-display)
(edebug-eval-result-list, edebug-eval-redisplay, edebug)
(edebug-trace): Fix typos in docstrings.
* emulation/tpu-edt.el (tpu-match-beginning, tpu-match-end)
(tpu-check-match, tpu-goto-breadcrumb, tpu-reset-screen-size)
(tpu-toggle-overwrite-mode, tpu-include, tpu-get, tpu-what-line)
(tpu-insert-escape, tpu-insert-formfeed, tpu-end-define-macro-key)
(tpu-check-search-case, tpu-select, tpu-unselect, tpu-trim-line-ends)
(tpu-toggle-control-keys): Fix typos in docstrings.
(tpu-kill-buffer): Doc fix.
(tpu-make-file-buffer-list, tpu-toggle-regexp, tpu-cut)
(tpu-append-region, tpu-delete-current-char, tpu-emacs-replace):
Reflow docstrings.
* eshell/em-smart.el (eshell-review-quick-commands): Doc fix.
* eshell/esh-arg.el (eshell-quote-backslash): Fix typo in docstring.
* play/solitaire.el (solitaire, solitaire-mode-map, solitaire-mode-hook)
(solitaire-mode, solitaire, solitaire-solve): Fix typos in docstrings.
* progmodes/gdb-ui.el (gdb-source-info): Fix typo in docstring.
* progmodes/python.el (python-comment-line-p, python-blank-line-p)
(python-skip-out): Doc fixes.
+2008-08-26 Juanma Barranquero <lekktu@gmail.com>
+
+ * facemenu.el (facemenu-unlisted-faces): Fix obsolescence declaration.
+
+ * hi-lock.el (hi-lock-mode): Fix typo in docstring.
+
+ * icomplete.el (icomplete-compute-delay, icomplete-get-keys): Doc fixes.
+ (icomplete-delay-completions-threshold): Fix typo in docstring.
+
+ * speedbar.el (speedbar-stealthy-function-list)
+ (speedbar-verbosity-level, speedbar-supported-extension-expressions)
+ (speedbar-update-current-file, speedbar-add-indicator)
+ (speedbar-tag-expand): Reflow docstrings.
+ (speedbar-use-imenu-flag, speedbar-use-tool-tips-flag)
+ (speedbar-ignored-directory-regexp, speedbar-file-unshown-regexp)
+ (speedbar-file-regexp, speedbar-message, speedbar-item-info)
+ (speedbar-files-item-info, speedbar-fetch-replacement-function)
+ (speedbar-maybe-add-localized-support)
+ (speedbar-generic-list-positioned-group-p, speedbar-insert-generic-list)
+ (speedbar-extract-one-symbol, speedbar-recenter-to-top)
+ (speedbar-recenter, speedbar-separator-face): Fix typos in docstrings.
+ (speedbar-ignored-directory-expressions, speedbar-handle-delete-frame)
+ (speedbar-show-info-under-mouse, speedbar-directory-buttons)
+ (speedbar-check-vc-this-line, speedbar-files-line-directory)
+ (speedbar-buffer-buttons, speedbar-buffer-buttons-temp)
+ (speedbar-buffers-line-directory): Doc fixes.
+
+ * tool-bar.el (tool-bar-add-item): Fix typo in docstring.
+
+ * emacs-lisp/edebug.el (edebug-unwrap*, edebug-signal)
+ (edebug-restore-status): Doc fixes.
+ (edebug-gensym, edebug-top-level-nonstop, edebug-eval-display)
+ (edebug-eval-result-list, edebug-eval-redisplay, edebug)
+ (edebug-trace): Fix typos in docstrings.
+
+ * emulation/tpu-edt.el (tpu-match-beginning, tpu-match-end)
+ (tpu-check-match, tpu-goto-breadcrumb, tpu-reset-screen-size)
+ (tpu-toggle-overwrite-mode, tpu-include, tpu-get, tpu-what-line)
+ (tpu-insert-escape, tpu-insert-formfeed, tpu-end-define-macro-key)
+ (tpu-check-search-case, tpu-select, tpu-unselect, tpu-trim-line-ends)
+ (tpu-toggle-control-keys): Fix typos in docstrings.
+ (tpu-kill-buffer): Doc fix.
+ (tpu-make-file-buffer-list, tpu-toggle-regexp, tpu-cut)
+ (tpu-append-region, tpu-delete-current-char, tpu-emacs-replace):
+ Reflow docstrings.
+
+ * eshell/em-smart.el (eshell-review-quick-commands): Doc fix.
+
+ * eshell/esh-arg.el (eshell-quote-backslash): Fix typo in docstring.
+
+ * play/solitaire.el (solitaire, solitaire-mode-map, solitaire-mode-hook)
+ (solitaire-mode, solitaire, solitaire-solve): Fix typos in docstrings.
+
+ * progmodes/gdb-ui.el (gdb-source-info): Fix typo in docstring.
+
+ * progmodes/python.el (python-comment-line-p, python-blank-line-p)
+ (python-skip-out): Doc fixes.
+
2008-08-25 Jay Belanger <jay.p.belanger@gmail.com>
* calc/calc-units.el (math-simplify-units-quotient): Replace
* files.el (abbreviate-file-name): When replacing $HOME with ~,
turn off case-fold-search.
-2008-07-31 Joachim Nilsson <joachim.nilsson@member.fsf.org> (tiny change)
+2008-07-31 Joachim Nilsson <joachim.nilsson@member.fsf.org> (tiny change)
* progmodes/cc-styles.el (c-style-alist): For the Ellemtel style,
move the (arglist-cont-nonempty) from c-offsets-alist to
(defun edebug-gensym (&optional prefix)
"Generate a fresh uninterned symbol.
-There is an optional argument, PREFIX. PREFIX is the
-string that begins the new name. Most people take just the default,
+There is an optional argument, PREFIX. PREFIX is the string
+that begins the new name. Most people take just the default,
except when debugging needs suggest otherwise."
(if (null prefix)
(setq prefix "G"))
sexp))
(defun edebug-unwrap* (sexp)
- "Return the sexp recursively unwrapped."
+ "Return the SEXP recursively unwrapped."
(let ((new-sexp (edebug-unwrap sexp)))
(while (not (eq sexp new-sexp))
(setq sexp new-sexp
This is the Edebug replacement for the standard `signal'. It should
only be active while Edebug is. It checks `debug-on-error' to see
whether it should call the debugger. When execution is resumed, the
-error is signaled again."
+error is signaled again.
+\n(fn SIGNAL-NAME DATA)"
(if (and (listp debug-on-error) (memq edebug-signal-name debug-on-error))
(edebug 'error (cons edebug-signal-name edebug-signal-data)))
;; If we reach here without another non-local exit, then send signal again.
(defun edebug-restore-status (var status)
"Reset VAR based on STATUS.
-STATUS should be a list you got from `edebug-var-status'."
+STATUS should be a list returned by `edebug-var-status'."
(let ((locus (car status))
(value (cdr status)))
(cond ((bufferp locus)
(defun edebug-top-level-nonstop ()
"Set mode to Go-nonstop, and exit to top-level.
-This is useful for exiting even if unwind-protect code may be executed."
+This is useful for exiting even if `unwind-protect' code may be executed."
(interactive)
(setq edebug-execution-mode 'Go-nonstop)
(top-level))
;; A list of expressions and their evaluations is displayed in *edebug*.
(defun edebug-eval-result-list ()
- "Return a list of evaluations of edebug-eval-list"
+ "Return a list of evaluations of `edebug-eval-list'."
;; Assumes in outside environment.
;; Don't do any edebug things now.
(let ((edebug-execution-mode 'Go-nonstop)
;; with calls in user functions, e.g. (edebug-eval-display)
(defun edebug-eval-display (edebug-eval-result-list)
- "Display expressions and evaluations in EVAL-LIST.
+ "Display expressions and evaluations in EDEBUG-EVAL-RESULT-LIST.
It modifies the context by popping up the eval display."
(if edebug-eval-result-list
(progn
(defun edebug-eval-redisplay ()
"Redisplay eval list in outside environment.
-May only be called from within edebug-recursive-edit."
+May only be called from within `edebug-recursive-edit'."
(edebug-create-eval-buffer)
(edebug-outside-excursion
(edebug-eval-display-list (edebug-eval-result-list))
;; edebug is not dependent on this, yet.
(defun edebug (&optional edebug-arg-mode &rest debugger-args)
- "Replacement for debug.
-If we are running an edebugged function,
-show where we last were. Otherwise call debug normally."
+ "Replacement for `debug'.
+If we are running an edebugged function,show where we last were.
+Otherwise call `debug' normally."
;; (message "entered: %s depth: %s edebug-recursion-depth: %s"
;; edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1)
(if (and edebug-entered ; anything active?
(defun edebug-trace (fmt &rest args)
- "Convenience call to edebug-trace-display using edebug-trace-buffer"
+ "Convenience call to `edebug-trace-display' using `edebug-trace-buffer'."
(apply 'edebug-trace-display edebug-trace-buffer fmt args))
\f
(set-marker tpu-match-end-mark nil))
(defun tpu-match-beginning nil
- "Returns the location of the last match beginning."
+ "Return the location of the last match beginning."
(marker-position tpu-match-beginning-mark))
(defun tpu-match-end nil
- "Returns the location of the last match end."
+ "Return the location of the last match end."
(marker-position tpu-match-end-mark))
(defun tpu-check-match nil
- "Returns t if point is between tpu-match markers.
+ "Return t if point is between tpu-match markers.
Otherwise sets the tpu-match markers to nil and returns nil."
;; make sure 1- marker is in this buffer
;; 2- point is at or after beginning marker
(message "Mark %d set." num))
(defun tpu-goto-breadcrumb (num)
- "Returns to a breadcrumb set with drop-breadcrumb."
+ "Return to a breadcrumb set with drop-breadcrumb."
(interactive "p")
(cond ((get tpu-breadcrumb-plist num)
(switch-to-buffer (car (get tpu-breadcrumb-plist num)))
tpu-version))
(defun tpu-reset-screen-size (height width)
- "Sets the screen size."
+ "Set the screen size."
(interactive "nnew screen height: \nnnew screen width: ")
(set-frame-height (selected-frame) height)
(set-frame-width (selected-frame) width))
(if tpu-newline-and-indent-p " and indents." "."))))
(defun tpu-spell-check nil
- "Checks the spelling of the region, or of the entire buffer if no
- region is selected."
+ "Check the spelling of the region, or of the entire buffer,
+ if no region is selected."
(interactive)
(cond (tpu-have-ispell
(if (tpu-mark) (ispell-region (tpu-mark) (point)) (ispell-buffer)))
(if (tpu-mark) (tpu-unselect t)))
(defun tpu-toggle-overwrite-mode nil
- "Switches in and out of overwrite mode"
+ "Switch in and out of overwrite mode."
(interactive)
(cond (overwrite-mode
(tpu-local-set-key "\177" tpu-saved-delete-func)
;;; TPU line-mode commands
;;;
(defun tpu-include (file)
- "TPU-like include file"
+ "TPU-like include file."
(interactive "fInclude file: ")
(insert-file-contents file)
(message ""))
(defun tpu-get (file)
- "TPU-like get file"
+ "TPU-like get file."
(interactive "FFile to get: ")
(find-file file find-file-wildcards))
(defun tpu-what-line nil
- "Tells what line the point is on,
+ "Tell what line the point is on,
and the total number of lines in the buffer."
(interactive)
(if (eobp)
;;; Auto-insert
;;;
(defun tpu-insert-escape nil
- "Inserts an escape character, and so becomes the escape-key alias."
+ "Insert an escape character, and so becomes the escape-key alias."
(interactive)
(insert "\e"))
(defun tpu-insert-formfeed nil
- "Inserts a formfeed character."
+ "Insert a formfeed character."
(interactive)
(insert "\C-L"))
(defvar tpu-saved-control-r nil "Saved value of Control-r.")
(defun tpu-end-define-macro-key (key)
- "Ends the current macro definition"
+ "End the current macro definition"
(interactive "kPress the key you want to use to do what was just learned: ")
(end-kbd-macro nil)
(global-set-key key last-kbd-macro)
;;; Buffers and Windows
;;;
(defun tpu-kill-buffer nil
- "Kills the current buffer. If tpu-kill-buffers-silently is non-nil,
-kills modified buffers without asking."
+ "Kill the current buffer.
+If `tpu-kill-buffers-silently' is non-nil,
+kill modified buffers without asking."
(interactive)
(if tpu-kill-buffers-silently (set-buffer-modified-p nil))
(kill-buffer (current-buffer)))
(switch-to-buffer (car (reverse list)))))
(defun tpu-make-file-buffer-list (buffer-list)
- "Returns names from BUFFER-LIST excluding those beginning with a space or star."
+ "Return names from BUFFER-LIST excluding those beginning with a space or star."
(delq nil (mapcar '(lambda (b)
(if (or (= (aref (buffer-name b) 0) ? )
(= (aref (buffer-name b) 0) ?*)) nil b))
;;; Search
;;;
(defun tpu-toggle-regexp nil
- "Switches in and out of regular expression search and replace mode."
+ "Switch in and out of regular expression search and replace mode."
(interactive)
(setq tpu-regexp-p (not tpu-regexp-p))
(tpu-set-search)
(defalias 'tpu-search-internal-core (symbol-function 'tpu-search-internal))
(defun tpu-check-search-case (string)
- "Returns t if string contains upper case."
+ "Return t if string contains upper case."
;; if using regexp, eliminate upper case forms (\B \W \S.)
(if tpu-regexp-p
(let ((pat (copy-sequence string)) (case-fold-search nil) (pos 0))
;;; Select / Unselect
;;;
(defun tpu-select (&optional quiet)
- "Sets the mark to define one end of a region."
+ "Set the mark to define one end of a region."
(interactive "P")
(cond ((tpu-mark)
(tpu-unselect quiet))
(if (not quiet) (message "Move the text cursor to select text.")))))
(defun tpu-unselect (&optional quiet)
- "Removes the mark to unselect the current region."
+ "Remove the mark to unselect the current region."
(interactive "P")
(deactivate-mark)
(setq mark-ring nil)
(tpu-error "No selection active."))))
(defun tpu-cut (arg)
- "Copy selected region to the cut buffer. In the absence of an
-argument, delete the selected region too."
+ "Copy selected region to the cut buffer.
+In the absence of an argument, delete the selected region too."
(interactive "P")
(if arg (tpu-store-text) (tpu-cut-text)))
(defun tpu-append-region (arg)
- "Append selected region to the tpu-cut buffer. In the absence of an
-argument, delete the selected region too."
+ "Append selected region to the tpu-cut buffer.
+In the absence of an argument, delete the selected region too."
(interactive "P")
(cond ((tpu-mark)
(let ((beg (region-beginning)) (end (region-end)))
(delete-region beg (point))))
(defun tpu-delete-current-char (num)
- "Delete one or specified number of characters after point. The last
-character deleted is saved for the TPU-edt undelete-char command."
+ "Delete one or specified number of characters after point.
+The last character deleted is saved for the TPU-edt undelete-char command."
(interactive "p")
(while (and (> num 0) (not (eobp)))
(setq tpu-last-deleted-char (char-after (point)))
(message "Replaced %s occurrence%s." strings (if (not (= 1 strings)) "s" ""))))
(defun tpu-emacs-replace (&optional dont-ask)
- "A TPU-edt interface to the Emacs replace functions. If TPU-edt is
-currently in regular expression mode, the Emacs regular expression
-replace functions are used. If an argument is supplied, replacements
-are performed without asking. Only works in forward direction."
+ "A TPU-edt interface to the Emacs replace functions.
+If TPU-edt is currently in regular expression mode, the Emacs regular
+expression replace functions are used. If an argument is supplied,
+replacements are performed without asking. Only works in forward direction."
(interactive "P")
(cond (dont-ask
(setq current-prefix-arg nil)
(end-of-line) (insert text) (forward-line))))))
(defun tpu-trim-line-ends nil
- "Removes trailing whitespace from every line in the buffer."
+ "Remove trailing whitespace from every line in the buffer."
(interactive)
(save-match-data
(save-excursion
(setq tpu-control-keys tpu-style)))
(defun tpu-toggle-control-keys nil
- "Toggles control key bindings between TPU-edt and Emacs."
+ "Toggle control key bindings between TPU-edt and Emacs."
(interactive)
(tpu-reset-control-keys (not tpu-control-keys))
(and (interactive-p)
command that produces no output, and exits successfully.
If set to `not-even-short-output', then the definition of \"quick
-command\" is extended to include commands that produce output, iff
-that output can be presented in its entirely in the Eshell window."
+command\" is extended to include commands that produce output, if and
+only if that output can be presented in its entirely in the Eshell window."
:type '(choice (const :tag "No" nil)
(const :tag "Yes" t)
(const :tag "Not even short output"
(= (+ pos 2) (point-max))))))
(defun eshell-quote-backslash (string &optional index)
- "Intelligently backslash the character occuring in STRING at INDEX.
+ "Intelligently backslash the character occurring in STRING at INDEX.
If the character is itself a backslash, it needs no escaping."
(let ((char (aref string index)))
(if (eq char ?\\)
,(purecopy "^widget-") ,(purecopy "^custom-") ,(purecopy "^vm-"))
"*List of faces that are of no interest to the user.")
(make-obsolete-variable 'facemenu-unlisted-faces 'facemenu-listed-faces
- "since 22.1,\nand has no effect on the Face menu")
+ "22.1,\nand has no effect on the Face menu")
(defcustom facemenu-listed-faces nil
"*List of faces to include in the Face menu.
Write active REGEXPs into buffer as comments (if possible). They may
be read the next time file is loaded or when the \\[hi-lock-find-patterns] command
is issued. The inserted regexps are in the form of font lock keywords.
- (See `font-lock-keywords'.) They may be edited and re-loaded with \\[hi-lock-find-patterns],
- any valid `font-lock-keywords' form is acceptable. When a file is
- loaded the patterns are read if `hi-lock-file-patterns-policy is
+ (See `font-lock-keywords'.) They may be edited and re-loaded with \\[hi-lock-find-patterns],
+ any valid `font-lock-keywords' form is acceptable. When a file is
+ loaded the patterns are read if `hi-lock-file-patterns-policy' is
'ask and the user responds y to the prompt, or if
`hi-lock-file-patterns-policy' is bound to a function and that
function returns t.
:group 'icomplete)
(defcustom icomplete-compute-delay .3
- "*Completions-computation stall, used only with large-number
-completions - see `icomplete-delay-completions-threshold'."
+ "*Completions-computation stall, used only with large-number completions.
+See `icomplete-delay-completions-threshold'."
:type 'number
:group 'icomplete)
(defcustom icomplete-delay-completions-threshold 400
- "*Pending-completions number over which to apply icomplete-compute-delay."
+ "*Pending-completions number over which to apply `icomplete-compute-delay'."
:type 'integer
:group 'icomplete)
(add-hook 'icomplete-post-command-hook 'icomplete-exhibit)
(defun icomplete-get-keys (func-name)
- "Return strings naming keys bound to `func-name', or nil if none.
+ "Return strings naming keys bound to FUNC-NAME, or nil if none.
Examines the prior, not current, buffer, presuming that current buffer
is minibuffer."
(if (commandp func-name)
;;; Code:
(defgroup solitaire nil
- "Game of solitaire."
+ "Game of Solitaire."
:prefix "solitaire-"
:group 'games)
(defvar solitaire-mode-map nil
- "Keymap for playing solitaire.")
+ "Keymap for playing Solitaire.")
(defcustom solitaire-mode-hook nil
- "Hook to run upon entry to solitaire."
+ "Hook to run upon entry to Solitaire."
:type 'hook
:group 'solitaire)
(put 'solitaire-mode 'mode-class 'special)
(defun solitaire-mode ()
- "Major mode for playing solitaire.
-To learn how to play solitaire, see the documentation for function
+ "Major mode for playing Solitaire.
+To learn how to play Solitaire, see the documentation for function
`solitaire'.
\\<solitaire-mode-map>
The usual mnemonic keys move the cursor around the board; in addition,
Undo moves using \\[solitaire-undo].
Check for possible moves using \\[solitaire-do-check].
\(The variable `solitaire-auto-eval' controls whether to automatically
-check after each move or undo)
+check after each move or undo.)
What is Solitaire?
;; And here's the spoiler:)
(defun solitaire-solve ()
- "Spoil solitaire by solving the game for you - nearly ...
+ "Spoil Solitaire by solving the game for you - nearly ...
... stops with five stones left ;)"
(interactive)
(when (< solitaire-stones 32)
(setq gdb-flush-pending-output t)
(setq gud-running nil)
(gdb-force-mode-line-update
- (propertize "stopped"'face font-lock-warning-face))
+ (propertize "stopped" 'face font-lock-warning-face))
(setq gdb-output-sink 'user)
(setq gdb-input-queue nil)
(setq gdb-pending-triggers nil)
(remove-hook 'after-save-hook 'gdb-create-define-alist t))
(defun gdb-source-info ()
- "Find the source file where the program starts and displays it with related
+ "Find the source file where the program starts and display it with related
buffers."
(goto-char (point-min))
(if (and (search-forward "Located in " nil t)
(error nil))))))))
(defun python-comment-line-p ()
- "Return non-nil iff current line has only a comment."
+ "Return non-nil if and only if current line has only a comment."
(save-excursion
(end-of-line)
(when (eq 'comment (syntax-ppss-context (syntax-ppss)))
(looking-at (rx (or (syntax comment-start) line-end))))))
(defun python-blank-line-p ()
- "Return non-nil iff current line is blank."
+ "Return non-nil if and only if current line is blank."
(save-excursion
(beginning-of-line)
(looking-at "\\s-*$")))
"Skip out of any nested brackets.
Skip forward if FORWARD is non-nil, else backward.
If SYNTAX is non-nil it is the state returned by `syntax-ppss' at point.
-Return non-nil iff skipping was done."
+Return non-nil if and only if skipping was done."
(let ((depth (syntax-ppss-depth (or syntax (syntax-ppss))))
(forward (if forward -1 1)))
(unless (zerop depth)
where NAME is the name of the major display mode these functions are
for, and the remaining elements FUNCTION are functions to call in order.
Each function must return nil if interrupted, or t if completed.
-Stealthy functions which have a single operation should always return
-t. Functions which take a long time should maintain a state (where
-they are in their speedbar related calculations) and permit
-interruption. See `speedbar-check-vc' as a good example.")
+Stealthy functions which have a single operation should always return t.
+Functions which take a long time should maintain a state (where they
+are in their speedbar related calculations) and permit interruption.
+See `speedbar-check-vc' as a good example.")
(defvar speedbar-mode-functions-list
'(("files" (speedbar-item-info . speedbar-files-item-info)
;;; EVENTUALLY REMOVE THESE
-;; When I moved to a repeating timer, I had the horrible missfortune
-;; of loosing the ability for adaptive speed choice. This update
+;; When I moved to a repeating timer, I had the horrible misfortune
+;; of losing the ability for adaptive speed choice. This update
;; speed currently causes long delays when it should have been turned off.
(defvar speedbar-update-speed dframe-update-speed
"*Obsoleted variable. Use `dframe-update-speed'.")
(sexp :tag "Value"))))
(defcustom speedbar-use-imenu-flag (fboundp 'imenu)
- "*Non-nil means use imenu for file parsing. nil to use etags.
+ "*Non-nil means use imenu for file parsing, nil to use etags.
XEmacs prior to 20.4 doesn't support imenu, therefore the default is to
use etags instead. Etags support is not as robust as imenu support."
:tag "Use Imenu for tags"
(defcustom speedbar-use-tool-tips-flag (and (not (featurep 'xemacs))
(>= emacs-major-version 21))
- "*Non-nil means to use tool tips if they are avaialble.
+ "*Non-nil means to use tool tips if they are available.
When tooltips are not available, mouse-tracking and minibuffer
display is used instead."
:group 'speedbar
:type 'hook)
(defcustom speedbar-verbosity-level 1
- "*Verbosity level of the speedbar. 0 means say nothing.
-1 means medium level verbosity. 2 and higher are higher levels of
-verbosity."
+ "*Verbosity level of the speedbar.
+0 means say nothing.
+1 means medium level verbosity.
+2 and higher are higher levels of verbosity."
:group 'speedbar
:type 'integer)
"\\)$")))
(defvar speedbar-ignored-directory-regexp nil
- "Regular expression matching directorys speedbar will not switch to.
+ "Regular expression matching directories speedbar will not switch to.
Created from `speedbar-ignored-directory-expressions' with the function
`speedbar-extension-list-to-regex' (A misnamed function in this case.)
Use the function `speedbar-add-ignored-directory-regexp', or customize the
(defcustom speedbar-ignored-directory-expressions
'("[/\\]logs?[/\\]\\'")
"*List of regular expressions matching directories speedbar will ignore.
-They should included directorys to directories which are notoriously very
-large and take a long time to load in. Use the function
+They should included directories which are notoriously very large
+and take a long time to load in. Use the function
`speedbar-add-ignored-directory-regexp' to add new items to this list after
speedbar is loaded. You may place anything you like in this list
before speedbar has been loaded."
;; backup refdir lockfile
(concat nstr "\\|#[^#]+#$\\|\\.\\.?\\'\\|\\.#"))
"*Regexp matching files we don't want displayed in a speedbar buffer.
-It is generated from the variable `completion-ignored-extensions'")
+It is generated from the variable `completion-ignored-extensions'.")
(defvar speedbar-file-regexp nil
"Regular expression matching files we know how to expand.
Created from `speedbar-supported-extension-expressions' with the
-function `speedbar-extension-list-to-regex'")
+function `speedbar-extension-list-to-regex'.")
;; this is dangerous to customize, because the defaults will probably
;; change in the future.
singular expression. This variable will be turned into
`speedbar-file-regexp' for use with speedbar. You should use the
function `speedbar-add-supported-extension' to add a new extension at
-runtime, or use the configuration dialog to set it in your .emacs
-file.
+runtime, or use the configuration dialog to set it in your .emacs file.
If you add an extension to this list, and it does not appear, you may
need to also modify `completion-ignored-extension' which will also help
file completion."
(defun speedbar-handle-delete-frame (e)
"Handle a delete frame event E.
-If the deleted frame is the frame SPEEDBAR is attached to,
+If the deleted frame is the frame speedbar is attached to,
we need to delete speedbar also."
(when (and speedbar-frame
(eq (car (car (cdr e))) ;; frame to be deleted
speedbar-buffer)
(defmacro speedbar-message (fmt &rest args)
- "Like message, but for use in the speedbar frame.
+ "Like `message', but for use in the speedbar frame.
Argument FMT is the format string, and ARGS are the arguments for message."
`(dframe-message ,fmt ,@args))
(t (speedbar-message nil)))))))
(defun speedbar-show-info-under-mouse ()
- "Call the info function for the line under the mouse.
-Optional EVENT is currently not used."
+ "Call the info function for the line under the mouse."
(let ((pos (mouse-position))) ; we ignore event until I use it later.
(if (equal (car pos) speedbar-frame)
(save-excursion
(point) (progn (end-of-line) (point))))))
(defun speedbar-item-info ()
- "Display info in the mini-buffer about the button the mouse is over.
+ "Display info in the minibuffer about the button the mouse is over.
This function can be replaced in `speedbar-mode-functions-list' as
`speedbar-item-info'."
(interactive)
nil)))))
(defun speedbar-files-item-info ()
- "Display info in the mini-buffer about the button the mouse is over."
+ "Display info in the minibuffer about the button the mouse is over."
(if (not speedbar-shown-directories)
(speedbar-generic-item-info)
(or (speedbar-item-info-file-helper)
(speedbar-reconfigure-keymaps))))
(defun speedbar-fetch-replacement-function (function)
- "Return a current mode specific replacement for function, or nil.
+ "Return a current mode-specific replacement for function, or nil.
Scans `speedbar-mode-functions-list' first for the current mode, then
for FUNCTION."
(cdr (assoc function
;;
(defun speedbar-maybe-add-localized-support (buffer)
"Quick check function called on BUFFERs by the speedbar timer function.
-Maintains the value of local variables which control speedbars use
+Maintains the value of local variables which control speedbar's use
of the special mode functions."
(or speedbar-special-mode-expansion-list
(speedbar-add-localized-speedbar-support buffer)))
(defun speedbar-directory-buttons (directory index)
"Insert a single button group at point for DIRECTORY.
-Each directory directory part is a different button. If part of the directory
+Each directory part is a different button. If part of the directory
matches the user directory ~, then it is replaced with a ~.
INDEX is not used, but is required by the caller."
(let* ((tilde (expand-file-name "~/"))
)))
(defun speedbar-generic-list-positioned-group-p (sublst)
- "Non-nil of SUBLST is a group with a position."
+ "Non-nil if SUBLST is a group with a position."
(and (stringp (car-safe sublst))
(number-or-marker-p (car-safe (cdr-safe sublst)))
(listp (cdr-safe (cdr-safe sublst)))
"At LEVEL, insert a generic multi-level alist LST.
Associations with lists get {+} tags (to expand into more nodes) and
those with positions just get a > as the indicator. {+} buttons will
-have the function EXPAND-FUN and the token is the CDR list. The token
+have the function EXPAND-FUN and the token is the cdr list. The token
name will have the function FIND-FUN and not token."
;; Remove imenu rescan button
(if (string= (car (car lst)) "*Rescan*")
(defun speedbar-update-current-file ()
"Find the current file, and update our visuals to indicate its name.
This is specific to file names. If the file name doesn't show up, but
-it should be in the list, then the directory cache needs to be
-updated."
+it should be in the list, then the directory cache needs to be updated."
(let* ((lastf (selected-frame))
(newcfd (save-excursion
(dframe-select-attached-frame speedbar-frame)
(defun speedbar-add-indicator (indicator-string &optional replace-this)
"Add INDICATOR-STRING to the end of this speedbar line.
-If INDICATOR-STRING is space, and REPLACE-THIS is a character, then
-the existing indicator is removed. If there is already an
+If INDICATOR-STRING is space, and REPLACE-THIS is a character,
+then the existing indicator is removed. If there is already an
indicator, then do not add a space."
(beginning-of-line)
;; The nature of the beast: Assume we are in "the right place"
t)))
(defun speedbar-check-vc-this-line (depth)
- "Return t if the file on this line is check of of a version control system.
+ "Return t if the file on this line is checked out of a version control system.
Parameter DEPTH is a string with the current depth of indentation of
the file being checked."
(let* ((d (string-to-number depth))
(if rf (funcall rf depth) default-directory))))
(defun speedbar-files-line-directory (&optional depth)
- "Retrieve the directoryname associated with the current line.
+ "Retrieve the directory associated with the current line.
This may require traversing backwards from DEPTH and combining the default
directory with these items."
(save-excursion
(defun speedbar-tag-expand (text token indent)
"Expand a tag sublist. Imenu will return sub-lists of specialized tag types.
-Etags does not support this feature. TEXT will be the button
-string. TOKEN will be the list, and INDENT is the current indentation
-level."
+Etags does not support this feature. TEXT will be the button string.
+TOKEN will be the list, and INDENT is the current indentation level."
(cond ((string-match "+" text) ;we have to expand this file
(speedbar-change-expand-button-char ?-)
(speedbar-with-writable
; (delete-region (match-beginning 1) (match-end 1)))))
(defun speedbar-extract-one-symbol (expr)
- "At point, return nil, or one alist in the form: (SYMBOL . POSITION)
+ "At point, return nil, or one alist in the form (SYMBOL . POSITION)
The line should contain output from etags. Parse the output using the
regular expression EXPR."
(let* ((sym (if (stringp expr)
(defun speedbar-buffer-buttons (directory zero)
"Create speedbar buttons based on the buffers currently loaded.
-DIRECTORY is the directory to the currently active buffer, and ZERO is 0."
+DIRECTORY is the directory of the currently active buffer, and ZERO is 0."
(speedbar-buffer-buttons-engine nil))
(defun speedbar-buffer-buttons-temp (directory zero)
"Create speedbar buttons based on the buffers currently loaded.
-DIRECTORY is the directory to the currently active buffer, and ZERO is 0."
+DIRECTORY is the directory of the currently active buffer, and ZERO is 0."
(speedbar-buffer-buttons-engine t))
(defun speedbar-buffer-buttons-engine (temp)
(or (buffer-file-name buffer) "<No file>"))))))
(defun speedbar-buffers-line-directory (&optional depth)
- "Fetch the full directory to the file (buffer) specified on the current line.
+ "Fetch the directory to the file (buffer) specified on the current line.
Optional argument DEPTH specifies the current depth of the back search."
(save-excursion
(end-of-line)
(remove-hook 'pre-command-hook 'speedbar-unhighlight-one-tag-line))
(defun speedbar-recenter-to-top ()
- "Recenter the current buffer so POINT is on the top of the window."
+ "Recenter the current buffer so point is on the top of the window."
(recenter 1))
(defun speedbar-recenter ()
- "Recenter the current buffer so POINT is in the center of the window."
+ "Recenter the current buffer so point is in the center of the window."
(recenter (/ (window-height (selected-window)) 2)))
\f
(:background "white"
:foreground "black"
:overline "black")))
- "Face used for separator labes in a display."
+ "Face used for separator labels in a display."
:group 'speedbar-faces)
;; some edebug hooks
If ARG is non-nil (interactively, with prefix argument), justify as well.
If `sentence-end-double-space' is non-nil, then period followed by one
space does not end a sentence, so don't break a line there.
-the variable `fill-column' controls the width for filling.
+The variable `fill-column' controls the width for filling.
If `fill-paragraph-function' is non-nil, we call it (passing our
argument to it), and if it returns non-nil, we simply return its value.
Info node `(elisp)Tool Bar'. Items are added from left to right.
ICON is the base name of a file containing the image to use. The
-function will first try to use low-color/ICON.xpm if display-color-cells
+function will first try to use low-color/ICON.xpm if `display-color-cells'
is less or equal to 256, then ICON.xpm, then ICON.pbm, and finally
ICON.xbm, using `find-image'.
projects / emacs.git / commitdiff