diff lisp/emacs-lisp/easymenu.el @ 62557:efeaec0ce9c4

(easy-menu-add): Correct docstring since easy-menu-add is not a nop on Emacs; and clarify when to call it.
author David Kastrup <dak@gnu.org>
date Fri, 20 May 2005 15:30:59 +0000
parents 2acfd9cf6713
children 925395d813a9 5b029ff3b08d
line wrap: on
line diff
--- a/lisp/emacs-lisp/easymenu.el	Fri May 20 14:30:34 2005 +0000
+++ b/lisp/emacs-lisp/easymenu.el	Fri May 20 15:30:59 2005 +0000
@@ -471,11 +471,15 @@
 
 (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)))