# HG changeset patch
# User Kim F. Storm <storm@cua.dk>
# Date 1146041792 0
# Node ID b85aa1663ba3f180991bd7dbe3c3dbc1bc966b83
# Parent  e73582101f202712c91a9d4ced6e68872f49f7f9
(posn-string, posn-image, posn-object): Doc fix.

diff -r e73582101f20 -r b85aa1663ba3 lisp/subr.el
--- a/lisp/subr.el	Wed Apr 26 08:56:23 2006 +0000
+++ b/lisp/subr.el	Wed Apr 26 08:56:32 2006 +0000
@@ -851,19 +851,23 @@
   (nth 3 position))
 
 (defsubst posn-string (position)
-  "Return the string object of POSITION, or nil if a buffer position.
+  "Return the string object of POSITION.
+Value is a cons (STRING . STRING-POS), or nil if not a string.
 POSITION should be a list of the form returned by the `event-start'
 and `event-end' functions."
   (nth 4 position))
 
 (defsubst posn-image (position)
-  "Return the image object of POSITION, or nil if a not an image.
+  "Return the image object of POSITION.
+Value is an list (image ...), or nil if not an image.
 POSITION should be a list of the form returned by the `event-start'
 and `event-end' functions."
   (nth 7 position))
 
 (defsubst posn-object (position)
   "Return the object (image or string) of POSITION.
+Value is a list (image ...) for an image object, a cons cell
+\(STRING . STRING-POS) for a string object, and nil for a buffer position.
 POSITION should be a list of the form returned by the `event-start'
 and `event-end' functions."
   (or (posn-image position) (posn-string position)))