; Improve documentation of 'easy-menu-define'

* doc/lispref/keymaps.texi (Easy Menu):
* lisp/emacs-lisp/easymenu.el (easy-menu-define): Document that
SYMBOL is also defined as a variable.  (Bug#73108)
This commit is contained in:
Eli Zaretskii 2024-09-14 11:55:08 +03:00
parent 3cad7cc8dc
commit ad289f364e
2 changed files with 4 additions and 2 deletions

View file

@ -3243,7 +3243,8 @@ contents are given by @var{menu}.
If @var{symbol} is non-@code{nil}, it should be a symbol; then this If @var{symbol} is non-@code{nil}, it should be a symbol; then this
macro defines @var{symbol} as a function for popping up the menu macro defines @var{symbol} as a function for popping up the menu
(@pxref{Pop-Up Menus}), with @var{doc} as its documentation string. (@pxref{Pop-Up Menus}), with @var{doc} as its documentation string. It
also defines @var{symbol} as a variable whose value is the menu.
@var{symbol} should not be quoted. @var{symbol} should not be quoted.
Regardless of the value of @var{symbol}, if @var{maps} is a keymap, Regardless of the value of @var{symbol}, if @var{maps} is a keymap,

View file

@ -38,7 +38,8 @@
(defmacro easy-menu-define (symbol maps doc menu) (defmacro easy-menu-define (symbol maps doc menu)
"Define a pop-up menu and/or menu bar menu specified by MENU. "Define a pop-up menu and/or menu bar menu specified by MENU.
If SYMBOL is non-nil, define SYMBOL as a function to pop up the If SYMBOL is non-nil, define SYMBOL as a function to pop up the
submenu defined by MENU, with DOC as its doc string. submenu defined by MENU, with DOC as its doc string. Also define
SYMBOL as a variable whose value is the menu.
MAPS, if non-nil, should be a keymap or a list of keymaps; add MAPS, if non-nil, should be a keymap or a list of keymaps; add
the submenu defined by MENU to the keymap or each of the keymaps, the submenu defined by MENU to the keymap or each of the keymaps,