aboutsummaryrefslogtreecommitdiffstats
path: root/src/w32menu.c
diff options
context:
space:
mode:
authorJason Rumney2001-11-12 23:57:09 +0000
committerJason Rumney2001-11-12 23:57:09 +0000
commit33f096701c84fc754bf5486cd2743dd030f5eb4a (patch)
tree8b94db4dad6b9dd0a7e94d0a492fea091d4f0f26 /src/w32menu.c
parentb6f4c7ba9cef461e5c827cb3f485ad82445ff85a (diff)
downloademacs-33f096701c84fc754bf5486cd2743dd030f5eb4a.tar.gz
emacs-33f096701c84fc754bf5486cd2743dd030f5eb4a.zip
Change doc-string comments to `new style'. [w/`doc:' keyword]. Doc fixes.
Diffstat (limited to 'src/w32menu.c')
-rw-r--r--src/w32menu.c96
1 files changed, 48 insertions, 48 deletions
diff --git a/src/w32menu.c b/src/w32menu.c
index d35af3025d1..2bf57e1870c 100644
--- a/src/w32menu.c
+++ b/src/w32menu.c
@@ -584,38 +584,37 @@ list_of_items (pane)
584} 584}
585 585
586DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0, 586DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
587 "Pop up a deck-of-cards menu and return user's selection.\n\ 587 doc: /* Pop up a deck-of-cards menu and return user's selection.
588POSITION is a position specification. This is either a mouse button event\n\ 588POSITION is a position specification. This is either a mouse button
589or a list ((XOFFSET YOFFSET) WINDOW)\n\ 589event or a list ((XOFFSET YOFFSET) WINDOW) where XOFFSET and YOFFSET
590where XOFFSET and YOFFSET are positions in pixels from the top left\n\ 590are positions in pixels from the top left corner of WINDOW's frame
591corner of WINDOW's frame. (WINDOW may be a frame object instead of a window.)\n\ 591\(WINDOW may be a frame object instead of a window). This controls the
592This controls the position of the center of the first line\n\ 592position of the center of the first line in the first pane of the
593in the first pane of the menu, not the top left of the menu as a whole.\n\ 593menu, not the top left of the menu as a whole. If POSITION is t, it
594If POSITION is t, it means to use the current mouse position.\n\ 594means to use the current mouse position.
595\n\ 595
596MENU is a specifier for a menu. For the simplest case, MENU is a keymap.\n\ 596MENU is a specifier for a menu. For the simplest case, MENU is a keymap.
597The menu items come from key bindings that have a menu string as well as\n\ 597The menu items come from key bindings that have a menu string as well as
598a definition; actually, the \"definition\" in such a key binding looks like\n\ 598a definition; actually, the \"definition\" in such a key binding looks like
599\(STRING . REAL-DEFINITION). To give the menu a title, put a string into\n\ 599\(STRING . REAL-DEFINITION). To give the menu a title, put a string into
600the keymap as a top-level element.\n\n\ 600the keymap as a top-level element.
601If REAL-DEFINITION is nil, that puts a nonselectable string in the menu.\n\ 601
602Otherwise, REAL-DEFINITION should be a valid key binding definition.\n\ 602If REAL-DEFINITION is nil, that puts a nonselectable string in the menu.
603\n\ 603Otherwise, REAL-DEFINITION should be a valid key binding definition.
604You can also use a list of keymaps as MENU.\n\ 604
605 Then each keymap makes a separate pane.\n\ 605You can also use a list of keymaps as MENU. Then each keymap makes a
606When MENU is a keymap or a list of keymaps, the return value\n\ 606separate pane. When MENU is a keymap or a list of keymaps, the return
607is a list of events.\n\n\ 607value is a list of events.
608\n\ 608
609Alternatively, you can specify a menu of multiple panes\n\ 609Alternatively, you can specify a menu of multiple panes with a list of
610 with a list of the form (TITLE PANE1 PANE2...),\n\ 610the form (TITLE PANE1 PANE2...), where each pane is a list of
611where each pane is a list of form (TITLE ITEM1 ITEM2...).\n\ 611form (TITLE ITEM1 ITEM2...).
612Each ITEM is normally a cons cell (STRING . VALUE);\n\ 612Each ITEM is normally a cons cell (STRING . VALUE); but a string can
613but a string can appear as an item--that makes a nonselectable line\n\ 613appear as an item--that makes a nonselectable line in the menu.
614in the menu.\n\ 614With this form of menu, the return value is VALUE from the chosen item.
615With this form of menu, the return value is VALUE from the chosen item.\n\ 615
616\n\ 616If POSITION is nil, don't display the menu at all, just precalculate the
617If POSITION is nil, don't display the menu at all, just precalculate the\n\ 617cached information about equivalent key sequences. */)
618cached information about equivalent key sequences.")
619 (position, menu) 618 (position, menu)
620 Lisp_Object position, menu; 619 Lisp_Object position, menu;
621{ 620{
@@ -808,20 +807,21 @@ cached information about equivalent key sequences.")
808#ifdef HAVE_MENUS 807#ifdef HAVE_MENUS
809 808
810DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0, 809DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0,
811 "Pop up a dialog box and return user's selection.\n\ 810 doc: /* Pop up a dialog box and return user's selection.
812POSITION specifies which frame to use.\n\ 811POSITION specifies which frame to use.
813This is normally a mouse button event or a window or frame.\n\ 812This is normally a mouse button event or a window or frame.
814If POSITION is t, it means to use the frame the mouse is on.\n\ 813If POSITION is t, it means to use the frame the mouse is on.
815The dialog box appears in the middle of the specified frame.\n\ 814The dialog box appears in the middle of the specified frame.
816\n\ 815
817CONTENTS specifies the alternatives to display in the dialog box.\n\ 816CONTENTS specifies the alternatives to display in the dialog box.
818It is a list of the form (TITLE ITEM1 ITEM2...).\n\ 817It is a list of the form (TITLE ITEM1 ITEM2...).
819Each ITEM is a cons cell (STRING . VALUE).\n\ 818Each ITEM is a cons cell (STRING . VALUE).
820The return value is VALUE from the chosen item.\n\n\ 819The return value is VALUE from the chosen item.
821An ITEM may also be just a string--that makes a nonselectable item.\n\ 820
822An ITEM may also be nil--that means to put all preceding items\n\ 821An ITEM may also be just a string--that makes a nonselectable item.
823on the left of the dialog box and all following items on the right.\n\ 822An ITEM may also be nil--that means to put all preceding items
824\(By default, approximately half appear on each side.)") 823on the left of the dialog box and all following items on the right.
824\(By default, approximately half appear on each side.) */)
825 (position, contents) 825 (position, contents)
826 Lisp_Object position, contents; 826 Lisp_Object position, contents;
827{ 827{
@@ -2229,8 +2229,8 @@ syms_of_w32menu ()
2229 staticpro (&Qdebug_on_next_call); 2229 staticpro (&Qdebug_on_next_call);
2230 2230
2231 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame, 2231 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame,
2232 "Frame for which we are updating a menu.\n\ 2232 doc: /* Frame for which we are updating a menu.
2233The enable predicate for a menu command should check this variable."); 2233The enable predicate for a menu command should check this variable. */);
2234 Vmenu_updating_frame = Qnil; 2234 Vmenu_updating_frame = Qnil;
2235 2235
2236 defsubr (&Sx_popup_menu); 2236 defsubr (&Sx_popup_menu);