diff options
| author | Richard M. Stallman <rms@gnu.org> | 2006-07-03 15:41:50 +0000 |
|---|---|---|
| committer | Richard M. Stallman <rms@gnu.org> | 2006-07-03 15:41:50 +0000 |
| commit | 933f07c9d6a57b28cca37f8ed2041e87b95ccb06 (patch) | |
| tree | c35c99340705d6e0e12b3e55d769f8b247da91e9 /src/textprop.c | |
| parent | 2b5022594f57ac84868c5f04777187d15c73bfc0 (diff) | |
| download | emacs-933f07c9d6a57b28cca37f8ed2041e87b95ccb06.tar.gz | |
(Fget_char_property_and_overlay): Doc fix.
Diffstat (limited to 'src/textprop.c')
| -rw-r--r-- | src/textprop.c | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/textprop.c b/src/textprop.c index a268afba830..0318d12913f 100644 --- a/src/textprop.c +++ b/src/textprop.c @@ -690,10 +690,11 @@ overlays are considered only if they are associated with OBJECT. */) 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 |