diff options
| author | Chong Yidong | 2012-02-15 12:00:34 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-02-15 12:00:34 +0800 |
| commit | c3a70e2b95e4cf41b1a671f7d721f0ba4aaff679 (patch) | |
| tree | e1632789ac2c8118ccac24691c4a91fe57109c55 /lisp | |
| parent | 9f26dc243268eddc252287ef1918970bf580e946 (diff) | |
| download | emacs-c3a70e2b95e4cf41b1a671f7d721f0ba4aaff679.tar.gz emacs-c3a70e2b95e4cf41b1a671f7d721f0ba4aaff679.zip | |
Doc updates for defvar, defconst, and defcustom.
* lisp/custom.el (defcustom): Doc fix; note use of defvar.
* src/eval.c (Fdefvar, Fdefconst): Doc fix; note that the variable is
marked as special. Also, starting docstrings with * is obsolete.
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/ChangeLog | 4 | ||||
| -rw-r--r-- | lisp/custom.el | 6 |
2 files changed, 9 insertions, 1 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index a3b5a4d9486..6ec2cd2f038 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2012-02-15 Chong Yidong <cyd@gnu.org> | ||
| 2 | |||
| 3 | * custom.el (defcustom): Doc fix; note use of defvar. | ||
| 4 | |||
| 1 | 2012-02-15 Glenn Morris <rgm@gnu.org> | 5 | 2012-02-15 Glenn Morris <rgm@gnu.org> |
| 2 | 6 | ||
| 3 | * mail/smtpmail.el (smtpmail-smtp-user, smtpmail-stream-type): | 7 | * mail/smtpmail.el (smtpmail-smtp-user, smtpmail-stream-type): |
diff --git a/lisp/custom.el b/lisp/custom.el index 2d880d23955..810b78144a4 100644 --- a/lisp/custom.el +++ b/lisp/custom.el | |||
| @@ -208,7 +208,11 @@ is unbound. The expression itself is also stored, so that | |||
| 208 | Customize can re-evaluate it later to get the standard value. | 208 | Customize can re-evaluate it later to get the standard value. |
| 209 | DOC is the variable documentation. | 209 | DOC is the variable documentation. |
| 210 | 210 | ||
| 211 | The remaining arguments should have the form | 211 | This macro uses `defvar' as a subroutine, which also marks the |
| 212 | variable as \"special\", so that it is always dynamically bound | ||
| 213 | even when `lexical-binding' is t. | ||
| 214 | |||
| 215 | The remaining arguments to `defcustom' should have the form | ||
| 212 | 216 | ||
| 213 | [KEYWORD VALUE]... | 217 | [KEYWORD VALUE]... |
| 214 | 218 | ||