1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00

desktop.el (desktop-buffer-info): Write docstring.

This commit is contained in:
Artur Malabarba 2015-03-05 13:37:23 +00:00
parent 17ecfea3b9
commit 6065fbe0d2
2 changed files with 20 additions and 0 deletions

View file

@ -756,6 +756,24 @@ is nil, ask the user where to save the desktop."
;; ----------------------------------------------------------------------------
(defun desktop-buffer-info (buffer)
"Return information describing BUFFER.
This function is not pure, as BUFFER is made current with
`set-buffer'.
Returns a list of all the necessary information to recreate the
buffer, which is (in order):
`uniquify-buffer-base-name';
`buffer-file-name';
`buffer-name';
`major-mode';
list of minor-modes,;
`point';
`mark';
`buffer-read-only';
auxiliary information given by `desktop-save-buffer';
local variables;
auxiliary information given by `desktop-var-serdes-funs'."
(set-buffer buffer)
(list
;; base name of the buffer; replaces the buffer name if managed by uniquify