Add coffee-mode.

[gnu-emacs-elpa] / packages / eldoc-eval / eldoc-eval.el

diff --git a/packages/eldoc-eval/eldoc-eval.el b/packages/eldoc-eval/eldoc-eval.el
index 536f5e6b09505c61082bcd49820cb772135bf02a..e157bdcdf466665d7da858160676a6b11d730734 100644 (file)
--- a/packages/eldoc-eval/eldoc-eval.el
+++ b/packages/eldoc-eval/eldoc-eval.el
@@ -1,8 +1,9 @@
-;;; eldoc-eval.el --- Show eldoc when using M-:
+;;; eldoc-eval.el --- Enable eldoc support when minibuffer is in use.
 
 ;; Copyright (C) 2011 Free Software Foundation, Inc.
 
 ;; Author: Thierry Volpiatto <thierry.volpiatto@gmail.com>
+;; Version: 0.1
 
 ;; This file is part of GNU Emacs.
 
@@ -20,6 +21,26 @@
 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
+;;
+;; This package enable eldoc support when minibuffer is in use.
+;;
+;; Eldoc info are shown by default in mode-line.
+;; but you can have eldoc info somewhere else by setting
+;; `eldoc-in-minibuffer-show-fn' to an other function (e.g `tooltip-show').
+;;
+;; By default with this package `M-:' will use `pp-eval-expression'
+;; instead of `eval-expression'; You can change that in
+;; `eval-prefered-function'.
+;;
+;; It provide also a convenient macro to enable eldoc support
+;; in your own functions using minibuffer or in your defadvices,
+;; that is `with-eldoc-in-minibuffer'.
+;;
+;; Users of own minibuffer frame will have to set
+;; `eldoc-in-minibuffer-own-frame-p' to non--nil.
+;;
+;; You can turn off at anytime eldoc support in minibuffer
+;; by setting `eldoc-in-minibuffer' to nil.
 
 ;;; Code:
 (require 'eldoc)
@@ -95,7 +116,7 @@ See `with-eldoc-in-minibuffer'."
      (cond (eldoc-in-minibuffer-own-frame-p
             (selected-window))
            ((fboundp 'window-in-direction)
-            (window-in-direction 
+            (window-in-direction
              'above (minibuffer-window)))
            (t (minibuffer-selected-window))))))