emacs-29 e3aae5fd385: ; Document 'filtered-frame-list'

[Eli Zaretskii]

branch: emacs-29
commit e3aae5fd385bd5512f614d2273a2d6d8e95a7ce6
Author: Eli Zaretskii <eliz@gnu.org>
Commit: Eli Zaretskii <eliz@gnu.org>

    ; Document 'filtered-frame-list'
    
    * doc/lispref/frames.texi (Finding All Frames): Document
    'filtered-frame-list'.
---
 doc/lispref/frames.texi | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index dc38f90ed74..edc080153d6 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -2804,6 +2804,18 @@ direction.
   See also @code{next-window} and @code{previous-window}, in @ref{Cyclic
 Window Ordering}.
 
+  Some Lisp programs need to find one or more frames that satisfy a
+given criteria.  The function @code{filtered-frame-list} is provided for
+this purpose.
+
+@defun filtered-frame-list predicate
+This function returns the list of all the live frames which satisfy the
+specified @var{predicate}.  The argument @var{predicate} must be a
+function of one argument, a frame to be tested against the filtering
+criteria, and should return non-@code{nil} if the frame satisfies the
+criteria.
+@end defun
+
 @node Minibuffers and Frames
 @section Minibuffers and Frames