From 6065fbe0d212857ecfa58e8a64fc4af3913c24e9 Mon Sep 17 00:00:00 2001 From: Artur Malabarba Date: Thu, 5 Mar 2015 13:37:23 +0000 Subject: desktop.el (desktop-buffer-info): Write docstring. --- lisp/desktop.el | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'lisp/desktop.el') diff --git a/lisp/desktop.el b/lisp/desktop.el index b85d8b257a5..8d151a74698 100644 --- a/lisp/desktop.el +++ b/lisp/desktop.el @@ -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 -- cgit v1.2.1