From: Artur Malabarba <am12548@it055607.users.bris.ac.uk>
Date: Thu, 5 Mar 2015 13:37:23 +0000 (+0000)
Subject: desktop.el (desktop-buffer-info): Write docstring.
X-Git-Tag: emacs-25.0.90~2564^2~218
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=6065fbe0d212857ecfa58e8a64fc4af3913c24e9;p=emacs.git

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

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 1f54617b4d4..d810ee8ce59 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,7 @@
 2015-03-05  Artur Malabarba  <bruce.connor.am@gmail.com>
 
+	* desktop.el (desktop-buffer-info): Write docstring.
+
 	* emacs-lisp/package.el (package-refresh-contents): Update doc.
 
 2015-03-05  Dmitry Gutov  <dgutov@yandex.ru>
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