Mercurial > emacs
changeset 71575:37f7b9440897
(Fget_char_property_and_overlay): Doc fix.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Mon, 03 Jul 2006 15:41:50 +0000 |
| parents | a93787ef56ad |
| children | b8678c550150 |
| files | src/textprop.c |
| diffstat | 1 files changed, 4 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/src/textprop.c Mon Jul 03 15:41:26 2006 +0000 +++ b/src/textprop.c Mon Jul 03 15:41:50 2006 +0000 @@ -690,10 +690,11 @@ DEFUN ("get-char-property-and-overlay", Fget_char_property_and_overlay, Sget_char_property_and_overlay, 2, 3, 0, doc: /* Like `get-char-property', but with extra overlay information. -Return a cons whose car is the return value of `get-char-property' -with the same arguments, that is, the value of POSITION's property -PROP in OBJECT, and whose cdr is the overlay in which the property was +The value is a cons cell. Its car is the return value of `get-char-property' +with the same arguments--that is, the value of POSITION's property +PROP in OBJECT. Its cdr is the overlay in which the property was found, or nil, if it was found as a text property or not found at all. + OBJECT is optional and defaults to the current buffer. OBJECT may be a string, a buffer or a window. For strings, the cdr of the return value is always nil, since strings do not have overlays. If OBJECT is