1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-04 08:47:11 +00:00

(Temporary Displays): Add xref to `Documentation Tips'.

This commit is contained in:
Luc Teirlinck 2003-10-23 20:41:28 +00:00
parent 97c437db33
commit d7cd58d7dc

View File

@ -801,11 +801,12 @@ they print into the buffer named @var{buffer-name}, which is first
created if necessary, and put into Help mode. Finally, the buffer is
displayed in some window, but not selected.
If the @var{forms} do not change the major mode in the output buffer, so
that it is still Help mode at the end of their execution, then
If the @var{forms} do not change the major mode in the output buffer,
so that it is still Help mode at the end of their execution, then
@code{with-output-to-temp-buffer} makes this buffer read-only at the
end, and also scans it for function and variable names to make them into
clickable cross-references.
end, and also scans it for function and variable names to make them
into clickable cross-references. @xref{Documentation Tips, , Tips for
Documentation Strings}.
The string @var{buffer-name} specifies the temporary buffer, which
need not already exist. The argument must be a string, not a buffer.