Mercurial > emacs
diff lispref/variables.texi @ 46391:5d5a55d8897b
Document third argument of defvaralias.
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Mon, 15 Jul 2002 15:50:20 +0000 |
parents | 51bf5310b422 |
children | d4d29178fccb |
line wrap: on
line diff
--- a/lispref/variables.texi Mon Jul 15 15:39:02 2002 +0000 +++ b/lispref/variables.texi Mon Jul 15 15:50:20 2002 +0000 @@ -1676,11 +1676,15 @@ to keep the old name as an @emph{alias} of the new one for compatibility. You can do this with @code{defvaralias}. -@defmac defvaralias alias-var base-var +@defmac defvaralias alias-var base-var [docstring] This function defines the symbol @var{alias-var} as a variable alias -for symbol @var{base-var}. This means that retrieving the value of +for symbol @var{base-var}. This means that retrieving the value of @var{alias-var} returns the value of @var{base-var}, and changing the value of @var{alias-var} changes the value of @var{base-var}. + +If the @var{docstring} argument is present, it specifies the documentation for +@var{alias-var}; otherwise, it has the same documentation that @var{base-var}, +if any. @end defmac @defun indirect-variable variable