diff options
| author | Jason Rumney | 2001-11-12 23:57:09 +0000 |
|---|---|---|
| committer | Jason Rumney | 2001-11-12 23:57:09 +0000 |
| commit | 33f096701c84fc754bf5486cd2743dd030f5eb4a (patch) | |
| tree | 8b94db4dad6b9dd0a7e94d0a492fea091d4f0f26 /src/w32menu.c | |
| parent | b6f4c7ba9cef461e5c827cb3f485ad82445ff85a (diff) | |
| download | emacs-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.c | 96 |
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 | ||
| 586 | DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0, | 586 | DEFUN ("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. |
| 588 | POSITION is a position specification. This is either a mouse button event\n\ | 588 | POSITION is a position specification. This is either a mouse button |
| 589 | or a list ((XOFFSET YOFFSET) WINDOW)\n\ | 589 | event or a list ((XOFFSET YOFFSET) WINDOW) where XOFFSET and YOFFSET |
| 590 | where XOFFSET and YOFFSET are positions in pixels from the top left\n\ | 590 | are positions in pixels from the top left corner of WINDOW's frame |
| 591 | corner 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 |
| 592 | This controls the position of the center of the first line\n\ | 592 | position of the center of the first line in the first pane of the |
| 593 | in the first pane of the menu, not the top left of the menu as a whole.\n\ | 593 | menu, not the top left of the menu as a whole. If POSITION is t, it |
| 594 | If POSITION is t, it means to use the current mouse position.\n\ | 594 | means to use the current mouse position. |
| 595 | \n\ | 595 | |
| 596 | MENU is a specifier for a menu. For the simplest case, MENU is a keymap.\n\ | 596 | MENU is a specifier for a menu. For the simplest case, MENU is a keymap. |
| 597 | The menu items come from key bindings that have a menu string as well as\n\ | 597 | The menu items come from key bindings that have a menu string as well as |
| 598 | a definition; actually, the \"definition\" in such a key binding looks like\n\ | 598 | a 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 |
| 600 | the keymap as a top-level element.\n\n\ | 600 | the keymap as a top-level element. |
| 601 | If REAL-DEFINITION is nil, that puts a nonselectable string in the menu.\n\ | 601 | |
| 602 | Otherwise, REAL-DEFINITION should be a valid key binding definition.\n\ | 602 | If REAL-DEFINITION is nil, that puts a nonselectable string in the menu. |
| 603 | \n\ | 603 | Otherwise, REAL-DEFINITION should be a valid key binding definition. |
| 604 | You can also use a list of keymaps as MENU.\n\ | 604 | |
| 605 | Then each keymap makes a separate pane.\n\ | 605 | You can also use a list of keymaps as MENU. Then each keymap makes a |
| 606 | When MENU is a keymap or a list of keymaps, the return value\n\ | 606 | separate pane. When MENU is a keymap or a list of keymaps, the return |
| 607 | is a list of events.\n\n\ | 607 | value is a list of events. |
| 608 | \n\ | 608 | |
| 609 | Alternatively, you can specify a menu of multiple panes\n\ | 609 | Alternatively, you can specify a menu of multiple panes with a list of |
| 610 | with a list of the form (TITLE PANE1 PANE2...),\n\ | 610 | the form (TITLE PANE1 PANE2...), where each pane is a list of |
| 611 | where each pane is a list of form (TITLE ITEM1 ITEM2...).\n\ | 611 | form (TITLE ITEM1 ITEM2...). |
| 612 | Each ITEM is normally a cons cell (STRING . VALUE);\n\ | 612 | Each ITEM is normally a cons cell (STRING . VALUE); but a string can |
| 613 | but a string can appear as an item--that makes a nonselectable line\n\ | 613 | appear as an item--that makes a nonselectable line in the menu. |
| 614 | in the menu.\n\ | 614 | With this form of menu, the return value is VALUE from the chosen item. |
| 615 | With this form of menu, the return value is VALUE from the chosen item.\n\ | 615 | |
| 616 | \n\ | 616 | If POSITION is nil, don't display the menu at all, just precalculate the |
| 617 | If POSITION is nil, don't display the menu at all, just precalculate the\n\ | 617 | cached information about equivalent key sequences. */) |
| 618 | cached 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 | ||
| 810 | DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0, | 809 | DEFUN ("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. |
| 812 | POSITION specifies which frame to use.\n\ | 811 | POSITION specifies which frame to use. |
| 813 | This is normally a mouse button event or a window or frame.\n\ | 812 | This is normally a mouse button event or a window or frame. |
| 814 | If POSITION is t, it means to use the frame the mouse is on.\n\ | 813 | If POSITION is t, it means to use the frame the mouse is on. |
| 815 | The dialog box appears in the middle of the specified frame.\n\ | 814 | The dialog box appears in the middle of the specified frame. |
| 816 | \n\ | 815 | |
| 817 | CONTENTS specifies the alternatives to display in the dialog box.\n\ | 816 | CONTENTS specifies the alternatives to display in the dialog box. |
| 818 | It is a list of the form (TITLE ITEM1 ITEM2...).\n\ | 817 | It is a list of the form (TITLE ITEM1 ITEM2...). |
| 819 | Each ITEM is a cons cell (STRING . VALUE).\n\ | 818 | Each ITEM is a cons cell (STRING . VALUE). |
| 820 | The return value is VALUE from the chosen item.\n\n\ | 819 | The return value is VALUE from the chosen item. |
| 821 | An ITEM may also be just a string--that makes a nonselectable item.\n\ | 820 | |
| 822 | An ITEM may also be nil--that means to put all preceding items\n\ | 821 | An ITEM may also be just a string--that makes a nonselectable item. |
| 823 | on the left of the dialog box and all following items on the right.\n\ | 822 | An ITEM may also be nil--that means to put all preceding items |
| 824 | \(By default, approximately half appear on each side.)") | 823 | on 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. |
| 2233 | The enable predicate for a menu command should check this variable."); | 2233 | The 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); |