diff options
| author | Martin Rudalics | 2017-09-25 10:09:32 +0200 |
|---|---|---|
| committer | Martin Rudalics | 2017-09-25 10:09:32 +0200 |
| commit | dc6b3560e56c83b3e3191a3d95d31fe288181742 (patch) | |
| tree | 998a37d181ebc8cca660d0851261a5d404165159 /lisp | |
| parent | 3d3778d82a87139ef50a24146f5bad2a57a82094 (diff) | |
| download | emacs-dc6b3560e56c83b3e3191a3d95d31fe288181742.tar.gz emacs-dc6b3560e56c83b3e3191a3d95d31fe288181742.zip | |
Fix documentation of `make-frame' and related variables and hooks
* lisp/frame.el (before-make-frame-hook)
(after-make-frame-functions, frame-inherited-parameters)
(make-frame): Fix doc-strings.
* doc/lispref/frames.texi (Creating Frames): Fix description
of `make-frame' and related variables and hooks.
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/frame.el | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/lisp/frame.el b/lisp/frame.el index 5f0e97d5b07..76c1842455c 100644 --- a/lisp/frame.el +++ b/lisp/frame.el | |||
| @@ -604,11 +604,12 @@ new frame." | |||
| 604 | (select-frame (make-frame)))) | 604 | (select-frame (make-frame)))) |
| 605 | 605 | ||
| 606 | (defvar before-make-frame-hook nil | 606 | (defvar before-make-frame-hook nil |
| 607 | "Functions to run before a frame is created.") | 607 | "Functions to run before `make-frame' creates a new frame.") |
| 608 | 608 | ||
| 609 | (defvar after-make-frame-functions nil | 609 | (defvar after-make-frame-functions nil |
| 610 | "Functions to run after a frame is created. | 610 | "Functions to run after `make-frame' created a new frame. |
| 611 | The functions are run with one arg, the newly created frame.") | 611 | The functions are run with one argument, the newly created |
| 612 | frame.") | ||
| 612 | 613 | ||
| 613 | (defvar after-setting-font-hook nil | 614 | (defvar after-setting-font-hook nil |
| 614 | "Functions to run after a frame's font has been changed.") | 615 | "Functions to run after a frame's font has been changed.") |
| @@ -617,7 +618,7 @@ The functions are run with one arg, the newly created frame.") | |||
| 617 | (define-obsolete-function-alias 'new-frame 'make-frame "22.1") | 618 | (define-obsolete-function-alias 'new-frame 'make-frame "22.1") |
| 618 | 619 | ||
| 619 | (defvar frame-inherited-parameters '() | 620 | (defvar frame-inherited-parameters '() |
| 620 | "Parameters `make-frame' copies from the `selected-frame' to the new frame.") | 621 | "Parameters `make-frame' copies from the selected to the new frame.") |
| 621 | 622 | ||
| 622 | (defvar x-display-name) | 623 | (defvar x-display-name) |
| 623 | 624 | ||
| @@ -632,9 +633,6 @@ form (NAME . VALUE), for example: | |||
| 632 | (width . NUMBER) The frame should be NUMBER characters in width. | 633 | (width . NUMBER) The frame should be NUMBER characters in width. |
| 633 | (height . NUMBER) The frame should be NUMBER text lines high. | 634 | (height . NUMBER) The frame should be NUMBER text lines high. |
| 634 | 635 | ||
| 635 | You cannot specify either `width' or `height', you must specify | ||
| 636 | neither or both. | ||
| 637 | |||
| 638 | (minibuffer . t) The frame should have a minibuffer. | 636 | (minibuffer . t) The frame should have a minibuffer. |
| 639 | (minibuffer . nil) The frame should have no minibuffer. | 637 | (minibuffer . nil) The frame should have no minibuffer. |
| 640 | (minibuffer . only) The frame should contain only a minibuffer. | 638 | (minibuffer . only) The frame should contain only a minibuffer. |
| @@ -650,10 +648,10 @@ neither or both. | |||
| 650 | In addition, any parameter specified in `default-frame-alist', | 648 | In addition, any parameter specified in `default-frame-alist', |
| 651 | but not present in PARAMETERS, is applied. | 649 | but not present in PARAMETERS, is applied. |
| 652 | 650 | ||
| 653 | Before creating the frame (via `frame-creation-function-alist'), | 651 | Before creating the frame (via `frame-creation-function'), this |
| 654 | this function runs the hook `before-make-frame-hook'. After | 652 | function runs the hook `before-make-frame-hook'. After creating |
| 655 | creating the frame, it runs the hook `after-make-frame-functions' | 653 | the frame, it runs the hook `after-make-frame-functions' with one |
| 656 | with one arg, the newly created frame. | 654 | argument, the newly created frame. |
| 657 | 655 | ||
| 658 | If a display parameter is supplied and a window-system is not, | 656 | If a display parameter is supplied and a window-system is not, |
| 659 | guess the window-system from the display. | 657 | guess the window-system from the display. |