procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve 'put-image' documentation

Browse source 
* doc/lispref/display.texi (Showing Images): Mention that it returns the
created overlay.
* lisp/image.el (put-image): And here.
This commit is contained in:
Robert Pluim 2024-07-09 17:14:45 +02:00
parent c38d5cc3b2
commit 945335fec1
2 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/lispref/display.texi
View file

@ -7093,7 +7093,9 @@ buffer's text.
Internally, this function creates an overlay, and gives it a
@code{before-string} property containing text that has a @code{display}
property whose value is the image. (Whew! that was a mouthful@dots{})
property whose value is the image. (Whew! that was a mouthful@dots{}).
It returns the created overlay upon success, and also sets its
@code{put-image} property to @code{t}.
@end defun
@defun remove-images start end &optional buffer

4
lisp/image.el
View file

@ -638,7 +638,9 @@ IMAGE must be an image created with `create-image' or `defimage'.
IMAGE is displayed by putting an overlay into the current buffer with a
`before-string' STRING that has a `display' property whose value is the
image. STRING defaults to \"x\" if it's nil or omitted.
The overlay created by this function has the `put-image' property set to t.
Upon success, this function returns the created overlay with its
`put-image' property set to t.
POS may be an integer or marker.
AREA is where to display the image. AREA nil or omitted means
display it in the text area, a value of `left-margin' means