aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/emacs-lisp/easymenu.el
diff options
context:
space:
mode:
authorDavid Kastrup <[email protected]>2005-05-20 15:30:59 +0000
committerDavid Kastrup <[email protected]>2005-05-20 15:30:59 +0000
commit8292be61c58c9eed64f132ccd688f889fa389230 (patch)
tree02facaf66f09734912a01435c46a767c2343da92 /lisp/emacs-lisp/easymenu.el
parent47bc4b3fe18e5cdbcd268699ad0cc5183cd33373 (diff)
(easy-menu-add): Correct docstring since
easy-menu-add is not a nop on Emacs; and clarify when to call it.
Diffstat (limited to 'lisp/emacs-lisp/easymenu.el')
-rw-r--r--lisp/emacs-lisp/easymenu.el14
1 files changed, 9 insertions, 5 deletions
diff --git a/lisp/emacs-lisp/easymenu.el b/lisp/emacs-lisp/easymenu.el
index c9f1769ae1..b3160c9b75 100644
--- a/lisp/emacs-lisp/easymenu.el
+++ b/lisp/emacs-lisp/easymenu.el
@@ -471,11 +471,15 @@ Contrary to XEmacs, this is a nop on Emacs since menus are automatically
(defun easy-menu-add (menu &optional map)
"Add the menu to the menubar.
-This is a nop on Emacs since menus are automatically activated when the
-corresponding keymap is activated. On XEmacs this is needed to actually
-add the menu to the current menubar.
-Maybe precalculate equivalent key bindings.
-Do it only if `easy-menu-precalculate-equivalent-keybindings' is on."
+On Emacs, menus are already automatically activated when the
+corresponding keymap is activated. On XEmacs this is needed to
+actually add the menu to the current menubar.
+
+This also precalculates equivalent key bindings when
+`easy-menu-precalculate-equivalent-keybindings' is on.
+
+You should call this once the menu and keybindings are set up
+completely and menu filter functions can be expected to work."
(when easy-menu-precalculate-equivalent-keybindings
(if (and (symbolp menu) (not (keymapp menu)) (boundp menu))
(setq menu (symbol-value menu)))