From: Kim F. Storm <storm@cua.dk>
Date: Thu, 13 Jan 2005 09:39:32 +0000 (+0000)
Subject: (Emulating Mode Line): Update format-mode-line entry.
X-Git-Tag: ttn-vms-21-2-B4~2781
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f2dfc8562962fe0e1bcf31260238348665937c4c;p=emacs.git

(Emulating Mode Line): Update format-mode-line entry.
---

diff --git a/lispref/modes.texi b/lispref/modes.texi
index ebedbc520b8..24cf95d6985 100644
--- a/lispref/modes.texi
+++ b/lispref/modes.texi
@@ -1736,7 +1736,7 @@ It is normally @code{nil}, so that ordinary buffers have no header line.
 the text that would appear in a mode line or header line
 based on certain mode-line specification.
 
-@defun format-mode-line format &optional window no-props buffer face
+@defun format-mode-line format &optional face window buffer
 This function formats a line of text according to @var{format} as if
 it were generating the mode line for @var{window}, but instead of
 displaying the text in the mode line or the header line, it returns
@@ -1752,13 +1752,12 @@ value which is usually @var{face}.  (If @var{face} is @code{t},
 that stands for either @code{mode-line} if @var{window} is selected,
 otherwise @code{mode-line-inactive}.)
 
-However, if @var{no-props} is non-@code{nil}, the value has no text
-properties.
+However, if @var{face} is an integer, the value has no text properties.
 
 For example, @code{(format-mode-line header-line-format)} returns the
 text that would appear in the selected window's header line (@code{""}
 if it has no header line).  @code{(format-mode-line header-line-format
-nil nil nil 'header-line)} returns the same text, with each character
+'header-line)} returns the same text, with each character
 carrying the face that it will have in the header line itself.
 @end defun