(easy-menu-add): Correct docstring since

easy-menu-add is not a nop on Emacs; and clarify when to call it.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index f35eec9e1f0a0a92ea384ee71efa6fc7c8716074..00f41a56f10d1991d0f9c2dbe16a6a5dad7f06d5 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2005-05-20  David Kastrup  <dak@gnu.org>
+
+       * emacs-lisp/easymenu.el (easy-menu-add): Correct docstring since
+       easy-menu-add is not a nop on Emacs; and clarify when to call it.
+
 2005-05-20  Carsten Dominik  <dominik@science.uva.nl>
 
        * textmodes/org.el (org-agenda-toggle-time-grid): New command.

diff --git a/lisp/emacs-lisp/easymenu.el b/lisp/emacs-lisp/easymenu.el
index c9f1769ae14f9960c966c7128e93118b11b059bd..b3160c9b7524fc611eac5667416acef247a98911 100644 (file)
--- 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)))