diff options
author | Lars Ingebrigtsen <larsi@gnus.org> | 2021-08-23 16:32:33 +0200 |
---|---|---|
committer | Lars Ingebrigtsen <larsi@gnus.org> | 2021-08-23 16:32:33 +0200 |
commit | 4167d4b4b2727ef9de5ad91228934eef11233e27 (patch) | |
tree | 0d59c0a6b6aa1cbd8ea72b5ad4a94ec6d1eabfa0 /src/frame.c | |
parent | 591b8bd87a30bda3dad680752b7f63da8b5b74bd (diff) | |
download | emacs-4167d4b4b2727ef9de5ad91228934eef11233e27.tar.gz emacs-4167d4b4b2727ef9de5ad91228934eef11233e27.tar.bz2 emacs-4167d4b4b2727ef9de5ad91228934eef11233e27.zip |
Clarify the documentation of `next-frame'
* doc/lispref/frames.texi (Finding All Frames): Clarify what it
means to "consider".
* src/frame.c (Fnext_frame): Rewrite doc string to say what the
parameters actually mean (bug#13339).
Diffstat (limited to 'src/frame.c')
-rw-r--r-- | src/frame.c | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/src/frame.c b/src/frame.c index b105268d423..c6b4c5946cb 100644 --- a/src/frame.c +++ b/src/frame.c @@ -1837,15 +1837,21 @@ prev_frame (Lisp_Object frame, Lisp_Object minibuf) DEFUN ("next-frame", Fnext_frame, Snext_frame, 0, 2, 0, doc: /* Return the next frame in the frame list after FRAME. -It considers only frames on the same terminal as FRAME. -By default, skip minibuffer-only frames. -If omitted, FRAME defaults to the selected frame. -If optional argument MINIFRAME is nil, exclude minibuffer-only frames. -If MINIFRAME is a window, include only its own frame -and any frame now using that window as the minibuffer. -If MINIFRAME is `visible', include all visible frames. -If MINIFRAME is 0, include all visible and iconified frames. -Otherwise, include all frames. */) +Only frames on the same terminal as FRAME are included. If omitted, +FRAME defaults to the selected frame. + +If MINIFRAME is nil (the default), include all frames except +minibuffer-only frames. + +If MINIFRAME is a window, include only its own frame and any frame now +using that window as the minibuffer. + +If MINIFRAME is `visible', only include visible frames. + +If MINIFRAME is 0, only include visible and iconified frames. + +If MINIFRAME is any other value than these values, include all +frames. */) (Lisp_Object frame, Lisp_Object miniframe) { if (NILP (frame)) |