changeset 57196:090c23fa222c

(insert-sliced-image): Add doc string.
author Kim F. Storm <storm@cua.dk>
date Wed, 22 Sep 2004 23:12:38 +0000
parents 720d7ae784c7
children 02ff6d10210c
files lisp/image.el
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/image.el	Wed Sep 22 23:12:22 2004 +0000
+++ b/lisp/image.el	Wed Sep 22 23:12:38 2004 +0000
@@ -228,6 +228,15 @@
 
 
 (defun insert-sliced-image (image &optional string area rows cols)
+  "Insert IMAGE into current buffer at point.
+IMAGE is displayed by inserting STRING into the current buffer
+with a `display' property whose value is the image.  STRING is
+defaulted if you omit it.
+AREA is where to display the image.  AREA nil or omitted means
+display it in the text area, a value of `left-margin' means
+display it in the left marginal area, a value of `right-margin'
+means display it in the right marginal area.
+The image is automatically split into ROW x COLS slices."
   (unless string (setq string " "))
   (unless (eq (car-safe image) 'image)
     (error "Not an image: %s" image))