1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00

; Improve documentation of incf and decf

* doc/lispref/variables.texi (Setting Generalized Variables): Mention
incf and decf.
* lisp/emacs-lisp/gv.el (incf, decf): Add references to Info manual
documentation on generalized variables.
This commit is contained in:
Stefan Kangas 2025-03-19 21:24:56 +01:00
parent 1fca171add
commit 03053baebe
2 changed files with 12 additions and 2 deletions

View file

@ -317,11 +317,14 @@ The return value is the last VAL in the list.
;;;###autoload
(defmacro incf (place &optional delta)
"Increment PLACE by DELTA (default to 1).
"Increment generalized variable PLACE by DELTA (default to 1).
The DELTA is first added to PLACE, and then stored in PLACE.
Return the incremented value of PLACE.
For more information about generalized variables, see Info node
`(elisp) Generalized Variables'.
See also `decf'."
(declare (debug (gv-place &optional form)))
(gv-letplace (getter setter) place
@ -329,11 +332,14 @@ See also `decf'."
;;;###autoload
(defmacro decf (place &optional delta)
"Decrement PLACE by DELTA (default to 1).
"Decrement generalized variable PLACE by DELTA (default to 1).
The DELTA is first subtracted from PLACE, and then stored in PLACE.
Return the decremented value of PLACE.
For more information about generalized variables, see Info node
`(elisp) Generalized Variables'.
See also `incf'."
(declare (debug (gv-place &optional form)))
(gv-letplace (getter setter) place