Function: semantic-idle-summary-mode

semantic-idle-summary-mode is an autoloaded, interactive and byte-compiled function defined in idle.el.gz.

Signature

(semantic-idle-summary-mode &optional ARG)

Documentation

Toggle Semantic Idle Summary mode.

When this minor mode is enabled, the echo area displays a summary of the lexical token at point whenever Emacs is idle.

This is a minor mode. If called interactively, toggle the Semantic-Idle-Summary mode mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

To check whether the minor mode is enabled in the current buffer, evaluate semantic-idle-summary-mode(var)/semantic-idle-summary-mode(fun).

The mode's hook is called both when the mode is enabled and when it is disabled.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/cedet/semantic/idle.el.gz
(define-minor-mode semantic-idle-summary-mode
  "Toggle Semantic Idle Summary mode.

When this minor mode is enabled, the echo area displays a summary
of the lexical token at point whenever Emacs is idle."
  :group 'semantic
  :group 'semantic-modes
  (remove-hook 'eldoc-documentation-functions #'semantic--eldoc-info t)
  (when semantic-idle-summary-mode
    ;; Enable the mode
    (unless (and (featurep 'semantic) (semantic-active-p))
      ;; Disable minor mode if semantic stuff not available
      (setq semantic-idle-summary-mode nil)
      (error "Buffer %s was not set up for parsing"
	     (buffer-name)))
    (add-hook 'eldoc-documentation-functions #'semantic--eldoc-info nil t)
    (eldoc-mode 1)))