summaryrefslogtreecommitdiff
path: root/src/textprop.c
diff options
context:
space:
mode:
authorChong Yidong <cyd@gnu.org>2013-12-20 15:12:04 +0800
committerChong Yidong <cyd@gnu.org>2013-12-20 15:12:04 +0800
commitf5df4cebdb5e2edfddd8b8e16b1c237e2dd45855 (patch)
tree1adb7cc9be1a1ba3ba7d0e90f5c3b59a2a414b1f /src/textprop.c
parentca65efcc2ea7f6876fee2f7d2d929dffa4093f96 (diff)
downloademacs-f5df4cebdb5e2edfddd8b8e16b1c237e2dd45855.tar.gz
Add/fix docs for add-face-text-property
* doc/lispref/text.texi (Changing Properties): Improve documentation for add-face-text-property. (Special Properties): Mention add-face-text-property. * src/textprop.c (Fadd_face_text_property): Doc fix. Rename `appendp' argument to `append'.
Diffstat (limited to 'src/textprop.c')
-rw-r--r--src/textprop.c25
1 files changed, 16 insertions, 9 deletions
diff --git a/src/textprop.c b/src/textprop.c
index 5597a781a61..d5f86922ade 100644
--- a/src/textprop.c
+++ b/src/textprop.c
@@ -1338,20 +1338,27 @@ the designated part of OBJECT. */)
DEFUN ("add-face-text-property", Fadd_face_text_property,
Sadd_face_text_property, 3, 5, 0,
doc: /* Add the face property to the text from START to END.
-The third argument FACE specifies the face to add.
-If any text in the region already has any face properties, this new
-face property will be added to the front of the face property list.
-If the optional fourth argument APPENDP is non-nil, append to the end
-of the face property list instead.
-If the optional fifth argument OBJECT is a buffer (or nil, which means
-the current buffer), START and END are buffer positions (integers or
+FACE specifies the face to add. It should be a valid value of the
+`face' property (typically a face name or a plist of face attributes
+and values).
+
+If any text in the region already has a non-nil `face' property, those
+face(s) are retained. This is done by setting the `face' property to
+a list of faces, with FACE as the first element (by default) and the
+pre-existing faces as the remaining elements.
+
+If optional fourth argument APPEND is non-nil, append FACE to the end
+of the face list instead.
+
+If optional fifth argument OBJECT is a buffer (or nil, which means the
+current buffer), START and END are buffer positions (integers or
markers). If OBJECT is a string, START and END are 0-based indices
into it. */)
(Lisp_Object start, Lisp_Object end, Lisp_Object face,
- Lisp_Object appendp, Lisp_Object object)
+ Lisp_Object append, Lisp_Object object)
{
add_text_properties_1 (start, end, list2 (Qface, face), object,
- (NILP (appendp)
+ (NILP (append)
? TEXT_PROPERTY_PREPEND
: TEXT_PROPERTY_APPEND));
return Qnil;