Commit eb6f7ed0 authored by Chong Yidong's avatar Chong Yidong
Browse files

(Fns_reset_menu, Fx_popup_menu): Change to use 'doc: /* ... */' style

of docstrings.  Doc fixes.
parent a5c55c69
...@@ -1860,7 +1860,7 @@ - (Lisp_Object)runDialogAt: (NSPoint)p ...@@ -1860,7 +1860,7 @@ - (Lisp_Object)runDialogAt: (NSPoint)p
========================================================================== */ ========================================================================== */
DEFUN ("ns-reset-menu", Fns_reset_menu, Sns_reset_menu, 0, 0, 0, DEFUN ("ns-reset-menu", Fns_reset_menu, Sns_reset_menu, 0, 0, 0,
"Cause the NS menu to be re-calculated.") doc: /* Cause the NS menu to be re-calculated. */)
() ()
{ {
set_frame_menubar (SELECTED_FRAME (), 1, 0); set_frame_menubar (SELECTED_FRAME (), 1, 0);
...@@ -1869,30 +1869,38 @@ - (Lisp_Object)runDialogAt: (NSPoint)p ...@@ -1869,30 +1869,38 @@ - (Lisp_Object)runDialogAt: (NSPoint)p
DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0, DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
"Pop up a deck-of-cards menu and return user's selection.\n\ doc: /* Pop up a deck-of-cards menu and return user's selection.
POSITION is a position specification. This is either a mouse button event\n\ POSITION is a position specification. This is either a mouse button event
or a list ((XOFFSET YOFFSET) WINDOW)\n\ or a list ((XOFFSET YOFFSET) WINDOW)
where XOFFSET and YOFFSET are positions in pixels from the top left\n\ where XOFFSET and YOFFSET are positions in pixels from the top left
corner of WINDOW's frame. (WINDOW may be a frame object instead of a window.)\n\ corner of WINDOW. (WINDOW may be a window or a frame object.)
This controls the position of the center of the first line\n\ This controls the position of the top left of the menu as a whole.
in the first pane of the menu, not the top left of the menu as a whole.\n\ If POSITION is t, it means to use the current mouse position.
\n\
MENU is a specifier for a menu. For the simplest case, MENU is a keymap.\n\ MENU is a specifier for a menu. For the simplest case, MENU is a keymap.
The menu items come from key bindings that have a menu string as well as\n\ The menu items come from key bindings that have a menu string as well as
a definition; actually, the \"definition\" in such a key binding looks like\n\ a definition; actually, the \"definition\" in such a key binding looks like
\(STRING . REAL-DEFINITION). To give the menu a title, put a string into\n\ \(STRING . REAL-DEFINITION). To give the menu a title, put a string into
the keymap as a top-level element.\n\n\ the keymap as a top-level element.
You can also use a list of keymaps as MENU.\n\
Then each keymap makes a separate pane.\n\ If REAL-DEFINITION is nil, that puts a nonselectable string in the menu.
When MENU is a keymap or a list of keymaps, the return value\n\ Otherwise, REAL-DEFINITION should be a valid key binding definition.
is a list of events.\n\n\
Alternatively, you can specify a menu of multiple panes\n\ You can also use a list of keymaps as MENU.
with a list of the form (TITLE PANE1 PANE2...),\n\ Then each keymap makes a separate pane.
where each pane is a list of form (TITLE ITEM1 ITEM2...).\n\
Each ITEM is normally a cons cell (STRING . VALUE);\n\ When MENU is a keymap or a list of keymaps, the return value is the
but a string can appear as an item--that makes a nonselectable line\n\ list of events corresponding to the user's choice. Note that
in the menu.\n\ `x-popup-menu' does not actually execute the command bound to that
With this form of menu, the return value is VALUE from the chosen item.") sequence of events.
Alternatively, you can specify a menu of multiple panes
with a list of the form (TITLE PANE1 PANE2...),
where each pane is a list of form (TITLE ITEM1 ITEM2...).
Each ITEM is normally a cons cell (STRING . VALUE);
but a string can appear as an item--that makes a nonselectable line
in the menu.
With this form of menu, the return value is VALUE from the chosen item. */)
(position, menu) (position, menu)
Lisp_Object position, menu; Lisp_Object position, menu;
{ {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment